public class LiteralWidget extends ControlTextWidget<TextConfig>
BaseEntity.CharsPixels
Modifier and Type | Field and Description |
---|---|
private boolean |
sideLabel
Side label discriminator, when true this instance represents a side label.
|
private GenericWidget<?> |
sideWidget
The associated side widget for this label (when
sideLabel is true). |
ALIGN_COLON, ALIGN_LEFT, ALIGN_RIGHT
group
config, deleted, frame
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
LiteralWidget()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
static LiteralWidget |
createSideLabel(GenericWidget<?> sideWidget)
Creates new instance representing a side label.
|
void |
explicitViewAs(boolean explicit)
Mark this widget as using an explicit VIEW-AS TEXT phrase.
|
character |
getLabel()
Get the label text for this widget.
|
handle |
getNextSibling()
Obtains the next sibling widget in the current field group.
|
handle |
getPrevSibling()
Obtains the previous sibling widget in the current field group.
|
character |
getScreenValue()
Obtain the current value in the screen buffer of the backing data for
this widget and return it as a
character type. |
boolean |
isTabWidget()
This widget can't be a tab item.
|
character |
name()
Get the name of this LITERAL widget - always unknown value.
|
protected void |
setColumnOrRowWorker(boolean isUnknown,
double value,
boolean row)
Sets the row or column position for this widget.
|
void |
setLabel(java.lang.String label)
This API is a no-op - it just raises an ERROR condition.
|
void |
setScreenValue(character value)
Set the current value in the screen buffer of the backing data for
this widget.
|
protected void |
setXOrYWorker(boolean isUnknown,
int value,
boolean x)
Sets the x or y pixel position for this widget.
|
private void |
updateSideLabelColumn(double col)
The method updates side label metrics after a change of column
position.
|
isReadOnly, setAt, setAtFormatLength, setForceLabel, setHeader, setReadOnly, setStatic
changeFontWorker, firstChild, getColon, getDataClass, getDataType, getIndex, getNextTabItem, getPreviousTabItem, getSideLabelHandle, getSizeAttrs, getTitle, hasSideLabelHandle, isAutoResize, isDropTarget, isModified, lastChild, processSideLabel, resetAutoResize, setAttrSpace, setAutoResize, setAutoResize, setColumnLabel, setColumnLabel, setDataType, setDataType, setDropTarget, setForceLabel, setHeightCharsWorker, setHeightPixelsWorker, setIndex, setIndex, setModified, setModified, setNoAttrSpace, setNoLabels, setTitle, setTitle, setTo, setTo, setWidthCharsWorker, setWidthPixelsWorker, validateFields
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getParent, getParent, getPfColor, getRow, getTooltip, getValidParentTypes, getWidthChars, getWidthPixels, getX, getY, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFgColorRgb, setFont, setGroup, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setTabStop, setTabStop, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels, setX, setX, setXorY, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, enable, finishConfigProcessing, finishSetup, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDbName, getFormat, getFrame, getFrameHandle, getHelp, getHWND, getId, getImage, getLabelFont, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getQuery, getRetainShape, getScreenValue, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMultiple, isNotEntered, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, notQueryable, notQueryable, notSettable, notSettable, notWorker, preRealizeCheck, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setVisible, setWidgetId, setWidgetId, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, view, widgetName
delete, firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData
getResourceType, id, id, instantiatingProcedure, invalidAttribute, setInstantiatingProcedure, type, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget
setScreenValue
getPrivateData, setPrivateData, setPrivateData
getResourceType
id, id, unknown
setDisableRedraw
private boolean sideLabel
private GenericWidget<?> sideWidget
sideLabel
is true).public LiteralWidget()
createSideLabel(GenericWidget)
.public static LiteralWidget createSideLabel(GenericWidget<?> sideWidget)
sideWidget
- The associated widget for this side-label.LiteralWidget
.public void explicitViewAs(boolean explicit)
explicit
- true
when there is a VIEW-AS TEXT phrase.public boolean isTabWidget()
isTabWidget
in class GenericWidget<TextConfig>
public handle getNextSibling()
getNextSibling
in interface CommonHandleChain
getNextSibling
in class BaseEntity<TextConfig>
public handle getPrevSibling()
getPrevSibling
in interface CommonHandleChain
getPrevSibling
in class ControlEntity<TextConfig>
public character getLabel()
Unlike other widget attribute getters, this API will raise an ERROR condition.
getLabel
in interface CommonField
getLabel
in class GenericWidget<TextConfig>
public void setLabel(java.lang.String label)
setLabel
in interface CommonField
setLabel
in class GenericWidget<TextConfig>
label
- The new label text.public character getScreenValue()
character
type. If
there is no value in the screen buffer (if it is null
which is the representation for an uninitialized value), then return
the empty string.getScreenValue
in interface CommonWidget
getScreenValue
in class GenericWidget<TextConfig>
character
type or the empty
string if the screen buffer value is uninitialized.public void setScreenValue(character value)
null
then this
widget will be set to the uninitialized value.setScreenValue
in interface CommonWidget
setScreenValue
in class GenericWidget<TextConfig>
value
- The new value for the widget, use null
to set
the value as uninitialized.public character name()
name
in interface Nameable
name
in class GenericWidget<TextConfig>
protected void setColumnOrRowWorker(boolean isUnknown, double value, boolean row)
Sub-classes can override this method; at this point, the parameters are valid.
setColumnOrRowWorker
in class BaseEntity<TextConfig>
isUnknown
- If true
the attribute value being set is an unknown value.value
- The 1-based row or column number.row
- If true
value
represents a row number, otherwise
a column number.protected void setXOrYWorker(boolean isUnknown, int value, boolean x)
Sub-classes can override this method; at this point, the parameters are valid.
setXOrYWorker
in class BaseEntity<TextConfig>
isUnknown
- If
true
the attribute value being set is an unknown value.value
- The x or y pixel value.x
- If true
value
represents an x
position, otherwise y.private void updateSideLabelColumn(double col)
col
- New widget column position.