T
- public abstract class BaseEntity<T extends BaseConfig> extends GenericWidget<T> implements CustomFont
Modifier and Type | Class and Description |
---|---|
(package private) static class |
BaseEntity.CharsPixels
Container for size in chars and pixels.
|
Modifier and Type | Field and Description |
---|---|
protected Group |
group
Group container for the widget and its siblings.
|
private CommonWidget |
parent
PARENT attribute
|
config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
BaseEntity(boolean dynamic,
T base)
Constructor.
|
BaseEntity(boolean dynamic,
T base,
BaseEntity<T> before,
boolean firstAsLast)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
protected decimal |
_getHeightChars()
Gets the HEIGHT-CHARS writable attribute.
|
protected integer |
_getHeightPixels()
Gets the HEIGHT-PIXELS writable attribute.
|
protected decimal |
_getWidthChars()
Gets the WIDTH-CHARS writable attribute.
|
protected integer |
_getWidthPixels()
Get rectangle width pixels.
|
protected boolean |
canSetPixelPositionInChui()
The method must return
true if this entity accepts assignment of X or Y
attributes in ChUI mode. |
protected void |
changeFontWorker(int font)
Sets the value for the FONT attribute.
|
protected void |
emit4084Warning(SizeAttribute attribute)
Report the "**Attribute must be greater than zero on widget" warning with
the code 4084.
|
private void |
emitNonPositiveAttributeWarning(int code,
SizeAttribute attribute)
Report the "**Attribute must be greater than zero on widget" warning
|
protected void |
emitUnableToAssignUnknownAttributeWarning(SizeAttribute attribute)
Report the "**Unable to assign UNKNOWN value to attribute ..." warning
|
integer |
getBgColor()
Gets the BGCOLOR writable attribute.
|
integer |
getBgColorRgb()
Gets the BGCOLOR-RGB writable attribute.
|
decimal |
getColumn()
Gets the COLUMN writable attribute.
|
integer |
getDColor()
In Chui mode gets the display color attribute.
|
integer |
getFgColor()
Gets the FGCOLOR writable attribute.
|
integer |
getFgColorRgb()
Gets the FGCOLOR-RGB writable attribute.
|
integer |
getFont()
Get the FONT attribute of this widget.
|
FontInfo |
getFontInfo()
Provides access to the custom font structure through
FontInfo . |
character |
getFontName()
Getter for the FONT-NAME attribute.
|
integer |
getFontSize()
Getter for the FONT-SIZE attribute.
|
decimal |
getFrameColumn()
Gets the FRAME-COL writable attribute.
|
decimal |
getFrameRow()
Gets the FRAME-ROW writable attribute.
|
integer |
getFrameX()
Gets the FRAME-X writable attribute.
|
integer |
getFrameY()
Gets the FRAME-Y writable attribute.
|
decimal |
getHeightChars()
Gets the HEIGHT-CHARS writable attribute.
|
integer |
getHeightPixels()
Get rectangle height pixels.
|
handle |
getNextSibling()
Obtains the next sibling widget in the current field group.
|
CommonWidget |
getParent()
Gets the PARENT writable attribute.
|
<P extends CommonWidget> |
getParent(java.lang.Class<P> clazz)
Returns the parent widget of the specified type.
|
integer |
getPfColor()
Gets the input (prompt/edit mode) color writable attribute.
|
handle |
getPrevSibling()
Obtains the previous sibling widget in the current field group.
|
decimal |
getRow()
Gets the ROW writable attribute.
|
protected void |
getSizeAttrs(java.util.List<java.lang.String> names,
java.util.List<java.lang.Object> vals)
Collect the size-related attributes which can be assigned by this widget.
|
character |
getTitle()
Gets the TITLE writable attribute.
|
character |
getTooltip()
Get TOOLTIP attribute.
|
protected java.lang.String[] |
getValidParentTypes()
Returns the widget types that can act as parent for this widget.
|
decimal |
getWidthChars()
Gets the WIDTH-CHARS writable attribute.
|
integer |
getWidthPixels()
Get rectangle width pixels.
|
integer |
getX()
Gets the X writable attribute.
|
integer |
getY()
Gets the Y writable attribute.
|
logical |
isFontBold()
Getter for the FONT-BOLD attribute.
|
logical |
isFontItalic()
Getter for the FONT-ITALIC attribute.
|
logical |
isFontUnderline()
Getter for the FONT-UNDERLINE attribute.
|
private boolean |
isInsideSetup()
Check if we are in a enclosing frame setup state.
|
logical |
isMovable()
Queries if the user is allowed to move this widget using direct manipulation.
|
private boolean |
isRedirected()
Check if we are in a redirected state.
|
logical |
isResizable()
Getter for RESIZABLE attribute.
|
logical |
isSelected()
Gets the SELECTED writable attribute.
|
logical |
isTabStop()
Get value of the TAB-STOP attribute.
|
(package private) BaseEntity.CharsPixels |
prepareSizeChars(java.lang.Double value,
SizeAttribute attr)
Get validated character and pixel values of the character attribute.
|
(package private) BaseEntity.CharsPixels |
prepareSizePixels(java.lang.Integer value,
SizeAttribute attr)
Get validated character and pixel values of the pixel attribute.
|
protected void |
pushLocAttrs(boolean row)
Push the location attributes to the client-side.
|
protected void |
pushSizeAttrs()
Push all the size-related attributes to the client-size.
|
protected void |
resetAutoResize()
Set AUTO-RESIZE to false if applicable
|
void |
setAlign(int mode)
Set alignment.
|
void |
setBgColor(int bgcolor)
Sets the BGCOLOR writable attribute.
|
void |
setBgColor(int64 bgcolor)
Sets the BGCOLOR writable attribute.
|
void |
setBgColor(NumberType bgcolor)
Sets the BGCOLOR writable attribute.
|
void |
setBgColorRgb(int bgcolorRgb)
Sets the BGCOLOR-RGB writable attribute.
|
void |
setBgColorRgb(NumberType bgcolorRgb)
Sets the BGCOLOR-RGB writable attribute.
|
void |
setColon(double colon)
Sets the column to which widget's colon between label and widget should
be aligned.
|
void |
setColon(NumberType colon)
Sets the column to which widget's colon between label and widget should
be aligned.
|
void |
setColumn(double c)
Sets the column position for this widget.
|
void |
setColumn(NumberType c)
Sets the column position for this widget.
|
protected void |
setColumnOrRow(boolean isUnknown,
double value,
boolean row)
Sets the row or column position for this widget.
|
protected void |
setColumnOrRowWorker(boolean isUnknown,
double value,
boolean row)
Sets the row or column position for this widget.
|
void |
setDColor(Color displayColor)
Sets the display color.
|
void |
setDColor(int color)
Set widget DCOLOR
|
void |
setDColor(NumberType param)
In Chui mode sets the display color attribute.
|
void |
setFgColor(int fgcolor)
Sets the FGCOLOR writable attribute.
|
void |
setFgColor(int64 fgcolor)
Sets the FGCOLOR writable attribute.
|
void |
setFgColor(NumberType fgcolor)
Sets the FGCOLOR writable attribute.
|
void |
setFgColorRgb(int fgcolorRgb)
Sets the FGCOLOR-RGB writable attribute.
|
void |
setFgColorRgb(NumberType fgcolorRgb)
Sets the FGCOLOR-RGB writable attribute.
|
void |
setFont(int64 fontNum)
Set the FONT attribute of this widget.
|
void |
setFontBold(logical value)
Setter for the FONT-BOLD attribute.
|
void |
setFontItalic(logical value)
Setter for the FONT-ITALIC attribute.
|
void |
setFontName(character name)
Setter for the FONT-NAME attribute.
|
void |
setFontSize(NumberType size)
Setter for the FONT-SIZE attribute.
|
void |
setFontUnderline(logical value)
Setter for the FONT-UNDERLINE attribute.
|
void |
setGroup(Group group)
Establishes a relationship between the container and the elements in
a given widget group.
|
void |
setHeightChars(double height)
Sets the HEIGHT-CHARS writable attribute.
|
void |
setHeightChars(NumberType height)
Sets the HEIGHT-CHARS writable attribute.
|
protected void |
setHeightCharsWorker(double height)
Sets the value for the attribute HEIGHT-CHARS in the associated config instance.
|
protected void |
setHeightImpl(int heightPixels,
SizeAttribute attribute)
Implementation for both
setHeightPixels(int) and setHeightChars(double) . |
void |
setHeightPixels(int heightPixels)
Sets new value of HEIGHT-PIXELS attribute.
|
void |
setHeightPixels(NumberType heightPixels)
Sets new value of HEIGHT-PIXELS attribute.
|
protected void |
setHeightPixelsWorker(int height)
Sets the value for the attribute HEIGHT-PIXELS in the associated config instance.
|
protected void |
setMaxHeightCharsWorker(double height)
Sets the value for the attribute MAX-HEIGHT-CHARS.
|
protected void |
setMaxHeightPixelsWorker(int height)
Sets the value for the attribute MAX-HEIGHT-PIXELS.
|
protected void |
setMaxWidthCharsWorker(double width)
Sets the value for the attribute MAX-WIDTH-CHARS.
|
protected void |
setMaxWidthPixelsWorker(int width)
Sets the value for the attribute MAX-WIDTH-PIXELS.
|
protected void |
setMinHeightCharsWorker(double height)
Sets the value for the attribute MIN-HEIGHT-CHARS.
|
protected void |
setMinHeightPixelsWorker(int height)
Sets the value for the attribute MIN-HEIGHT-PIXELS.
|
protected void |
setMinWidthCharsWorker(double width)
Sets the value for the attribute MIN-WIDTH-CHARS.
|
protected void |
setMinWidthPixelsWorker(int width)
Sets the value for the attribute MIN-WIDTH-PIXELS.
|
void |
setMovable(boolean movable)
Defines if the user is allowed to move this widget using direct manipulation.
|
void |
setMovable(logical movable)
Defines if the user is allowed to move this widget using direct manipulation.
|
void |
setParent(GenericWidget<?> widget)
Sets the PARENT writable attribute.
|
void |
setPfColor(Color inputColor)
Sets the input (prompt/edit mode) color.
|
void |
setPfColor(int color)
Set widget PFCOLOR
|
void |
setPfColor(NumberType param)
Sets the input (prompt/edit mode) color.
|
void |
setResizable(boolean on)
Setter for RESIZABLE attribute.
|
void |
setResizable(logical on)
Setter for RESIZABLE attribute.
|
void |
setRow(double r)
Sets the row position for this widget.
|
void |
setRow(NumberType r)
Sets the row position for this widget.
|
void |
setSelected(boolean sel)
Sets the SELECTED writable attribute.
|
void |
setSelected(logical sel)
Sets the SELECTED writable attribute.
|
protected void |
setSizeChars(java.lang.Double value,
SizeAttribute attr)
Sets one of the size char attributes, that is WIDTH-CHARS, HEIGHT-CHARS,
MIN-WIDTH-CHARS, MIN-HEIGHT-CHARS, MAX-WIDTH-CHARS, MAX-HEIGHT-CHARS,
VIRTUAL-WIDTH_CHARS, VIRTUAL-HEIGHT-CHARS.
|
protected void |
setSizePixels(java.lang.Integer value,
SizeAttribute attr)
Sets one of the size pixel attributes, that is WIDTH-PIXELS, HEIGHT-PIXELS,
MIN-WIDTH-PIXELS, MIN-HEIGHT-PIXELS, MAX-WIDTH-PIXELS, MAX-HEIGHT-PIXELS,
VIRTUAL-WIDTH_PIXELS, VIRTUAL-HEIGHT-PIXELS.
|
void |
setSystemParent(GenericWidget<?> widget)
Sets the system parent for this widget.
|
void |
setTabStop(boolean value)
Set value of the TAB-STOP attribute.
|
void |
setTabStop(logical value)
Set value of the TAB-STOP attribute.
|
void |
setTitle(character title)
Sets the TITLE writable attribute.
|
void |
setTitle(java.lang.String title)
Sets the TITLE writable attribute.
|
void |
setTooltip(character tooltip)
Set new value of TOOLTIP attribute.
|
void |
setTooltip(java.lang.String tooltip)
Set new value of TOOLTIP attribute.
|
protected void |
setVirtHeightCharsWorker(double height)
Sets the value for the attribute VIRTUAL-HEIGHT-CHARS.
|
protected void |
setVirtHeightPixelsWorker(int height)
Sets the value for the attribute VIRTUAL-HEIGHT-PIXELS.
|
protected void |
setVirtWidthCharsWorker(double width)
Sets the value for the attribute VIRTUAL-WIDTH-CHARS.
|
protected void |
setVirtWidthPixelsWorker(int width)
Sets the value for the attribute VIRTUAL-WIDTH-PIXELS.
|
void |
setWidthChars(double width)
Sets the WIDTH-CHARS writable attribute.
|
void |
setWidthChars(NumberType width)
Sets the WIDTH-CHARS writable attribute.
|
protected void |
setWidthCharsWorker(double width)
Sets the value for the attribute WIDTH-CHARS in the associated config instance.
|
protected void |
setWidthImpl(int widthPixels,
SizeAttribute attribute)
Implementation for both
setWidthPixels(int) and setWidthChars(double) . |
void |
setWidthPixels(int widthPixels)
Sets the WIDTH-PIXELS writable attribute.
|
void |
setWidthPixels(NumberType widthPixels)
Sets the WIDTH-PIXELS writable attribute.
|
protected void |
setWidthPixelsWorker(int width)
Sets the value for the attribute WIDTH-PIXELS in the associated config instance.
|
void |
setX(int x)
Sets the X writable attribute.
|
void |
setX(NumberType x)
Sets the X writable attribute.
|
protected void |
setXorY(boolean isUnknown,
int value,
boolean x)
Sets the X or Y position for this widget.
|
protected void |
setXOrYWorker(boolean isUnknown,
int value,
boolean x)
Sets the x or y pixel position for this widget.
|
void |
setY(int y)
Sets the Y writable attribute.
|
void |
setY(NumberType y)
Sets the Y writable attribute.
|
protected boolean |
useHandleChainSiblings()
Indicates an implementation of siblings methods.
|
protected boolean |
validateParent(GenericWidget<?> widget)
Checks whether the supplied widget can be used as a valid parent
of this widget.
|
protected boolean |
validateSize(java.lang.Number value,
SizeAttribute attr)
Performs a validation of widget size value.
|
protected boolean |
validColumnOrRow(boolean isUnknown,
double value,
boolean row)
Checks if the row or column position for this widget can be set.
|
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, delete, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, processSideLabel, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, 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, setWidth, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName
doDelete, getResourceType, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, setInstantiatingProcedure, toString, type, unableToAssignUnknown, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue
getPrivateData, setPrivateData, setPrivateData
getResourceType
id, id, unknown
setDisableRedraw
private CommonWidget parent
protected Group group
public BaseEntity(boolean dynamic, T base)
dynamic
- Flag indicating if this is a static or dynamic resource.base
- The container for all state to be transferred to the client.public BaseEntity(boolean dynamic, T base, BaseEntity<T> before, boolean firstAsLast)
dynamic
- Flag indicating if this is a static or dynamic resource.base
- The container for all state to be transferred to the client.before
- The right neighbor of the BaseEntity been created or null if new BaseEntity
will be the last in the chain. If before is the first element in the chain
the new BaseEntity will become the new first element in the chain.firstAsLast
- The flag indicating that this new entity must be inserted as last element
in the chain in the case when before - is the first element of the chain.
When before is the first element of the chain, default behavior (expected
from the name of this parameter is to insert new element as the first.
This flag allows to change the expected behavior of before parameter when
it needs and makes sense only if before is the first element.BaseEntity.CharsPixels prepareSizeChars(java.lang.Double value, SizeAttribute attr)
value
- The attribute value, in pixels. null
denotes an unknown attribute
value.attr
- The attribute being converted.null
if attribute value
is not valid.BaseEntity.CharsPixels prepareSizePixels(java.lang.Integer value, SizeAttribute attr)
value
- The attribute value, in characters. null
denotes an unknown attribute
value.attr
- The attribute being converted.null
if attribute value
is not valid.public void setColon(NumberType colon)
colon
- The 1-based column number. This is converted to a 0-based
column number for the internal runtime.public void setColon(double colon)
colon
- The 1-based column number. This is converted to a 0-based
column number for the internal runtime.public decimal getColumn()
getColumn
in interface Coordinates
getColumn
in class GenericWidget<T extends BaseConfig>
public void setColumn(NumberType c)
setColumn
in interface Coordinates
setColumn
in class GenericWidget<T extends BaseConfig>
c
- The 1-based column number at which to start displaying the
widget. This is converted to a 0-based column number for the
internal runtime.public void setColumn(double c)
setColumn
in interface Coordinates
setColumn
in class GenericWidget<T extends BaseConfig>
c
- The 1-based column number at which to start displaying the
widget. This is converted to a 0-based column number for the
internal runtime.public integer getDColor()
getDColor
in interface CommonWidget
getDColor
in class GenericWidget<T extends BaseConfig>
public void setDColor(NumberType param)
setDColor
in interface CommonWidget
setDColor
in class GenericWidget<T extends BaseConfig>
param
- The display color.public void setDColor(Color displayColor)
setDColor
in interface CommonWidget
setDColor
in class GenericWidget<T extends BaseConfig>
displayColor
- The display color.public void setDColor(int color)
color
- Integer color value.public integer getFgColor()
getFgColor
in interface CommonWidget
getFgColor
in class GenericWidget<T extends BaseConfig>
public void setFgColor(NumberType fgcolor)
setFgColor
in interface CommonWidget
setFgColor
in class GenericWidget<T extends BaseConfig>
fgcolor
- The new value for the FGCOLOR attribute.public void setFgColor(int64 fgcolor)
fgcolor
- The new value for the FGCOLOR attribute.public void setFgColor(int fgcolor)
fgcolor
- The new value for the FGCOLOR attribute.public integer getBgColor()
getBgColor
in interface CommonWidget
getBgColor
in class GenericWidget<T extends BaseConfig>
public void setBgColor(NumberType bgcolor)
setBgColor
in interface CommonWidget
setBgColor
in class GenericWidget<T extends BaseConfig>
bgcolor
- The new value for the BGCOLOR attribute.public void setBgColor(int64 bgcolor)
bgcolor
- The new value for the BGCOLOR attribute.public void setBgColor(int bgcolor)
bgcolor
- The new value for the BGCOLOR attribute.public integer getFgColorRgb()
getFgColorRgb
in interface CommonWidget
getFgColorRgb
in class GenericWidget<T extends BaseConfig>
public void setFgColorRgb(NumberType fgcolorRgb)
setFgColorRgb
in interface CommonWidget
setFgColorRgb
in class GenericWidget<T extends BaseConfig>
fgcolorRgb
- The new value for the FGCOLOR-RGB attribute.public void setFgColorRgb(int fgcolorRgb)
fgcolorRgb
- The new value for the FGCOLOR-RGB attribute.public integer getBgColorRgb()
getBgColorRgb
in interface CommonWidget
getBgColorRgb
in class GenericWidget<T extends BaseConfig>
public void setBgColorRgb(NumberType bgcolorRgb)
setBgColorRgb
in interface CommonWidget
setBgColorRgb
in class GenericWidget<T extends BaseConfig>
bgcolorRgb
- The new value for the BGCOLOR-RGB attribute.public void setBgColorRgb(int bgcolorRgb)
bgcolorRgb
- The new value for the BGCOLOR-RGB attribute.public void setAlign(int mode)
mode
- Set alignment mode.public decimal getHeightChars()
getHeightChars
in interface Sizeable
getHeightChars
in class GenericWidget<T extends BaseConfig>
public void setHeightChars(NumberType height)
setHeightChars
in interface Sizeable
setHeightChars
in class GenericWidget<T extends BaseConfig>
height
- The new value for the HEIGHT-CHARS attribute.public void setHeightChars(double height)
setHeightChars
in interface Sizeable
setHeightChars
in class GenericWidget<T extends BaseConfig>
height
- The new value for the HEIGHT-CHARS attribute.public decimal getWidthChars()
getWidthChars
in interface Sizeable
getWidthChars
in class GenericWidget<T extends BaseConfig>
public void setWidthChars(NumberType width)
setWidthChars
in interface Sizeable
setWidthChars
in class GenericWidget<T extends BaseConfig>
width
- The new value for the WIDTH-CHARS attribute.public void setWidthChars(double width)
setWidthChars
in interface Sizeable
setWidthChars
in class GenericWidget<T extends BaseConfig>
width
- The new value for the WIDTH-CHARS attribute.public integer getHeightPixels()
getHeightPixels
in interface Sizeable
getHeightPixels
in class GenericWidget<T extends BaseConfig>
public integer getWidthPixels()
getWidthPixels
in interface Sizeable
getWidthPixels
in class GenericWidget<T extends BaseConfig>
public CommonWidget getParent()
getParent
in interface CommonWidget
getParent
in class GenericWidget<T extends BaseConfig>
public <P extends CommonWidget> P getParent(java.lang.Class<P> clazz)
null
is returned.P
- The expected parent type.clazz
- The expected parent type to return.public void setParent(GenericWidget<?> widget)
setParent
in interface CommonWidget
setParent
in class GenericWidget<T extends BaseConfig>
widget
- The new value for the PARENT attribute.public void setSystemParent(GenericWidget<?> widget)
widget
- The new system parent. If null
the current system parent will be unset.public void setGroup(Group group)
setGroup
in interface CommonWidget
setGroup
in class GenericWidget<T extends BaseConfig>
group
- The container of the widget.public handle getNextSibling()
getNextSibling
in interface CommonHandleChain
getNextSibling
in class HandleChain
public handle getPrevSibling()
getPrevSibling
in interface CommonHandleChain
getPrevSibling
in class HandleChain
public logical isMovable()
isMovable
in interface CommonWidget
isMovable
in class GenericWidget<T extends BaseConfig>
true
, the widget is movable via direct manipulation.public void setMovable(boolean movable)
setMovable
in interface CommonWidget
setMovable
in class GenericWidget<T extends BaseConfig>
movable
- true
to enable movable direct manipulation.public void setMovable(logical movable)
setMovable
in interface CommonWidget
setMovable
in class GenericWidget<T extends BaseConfig>
movable
- true
to enable movable direct manipulation.public logical isResizable()
isResizable
in interface CommonWidget
isResizable
in class GenericWidget<T extends BaseConfig>
true
if widget is resizable.public void setResizable(boolean on)
setResizable
in interface CommonWidget
setResizable
in class GenericWidget<T extends BaseConfig>
on
- true
to make the widget resizablepublic void setResizable(logical on)
setResizable
in interface CommonWidget
setResizable
in class GenericWidget<T extends BaseConfig>
on
- true
to make the widget resizablepublic integer getPfColor()
getPfColor
in interface CommonWidget
getPfColor
in class GenericWidget<T extends BaseConfig>
public void setPfColor(NumberType param)
setPfColor
in interface CommonWidget
setPfColor
in class GenericWidget<T extends BaseConfig>
param
- The color to use.public void setPfColor(Color inputColor)
setPfColor
in interface CommonWidget
setPfColor
in class GenericWidget<T extends BaseConfig>
inputColor
- The color to use for when in "input" mode.public void setPfColor(int color)
color
- Integer color value.public decimal getRow()
getRow
in interface Coordinates
getRow
in class GenericWidget<T extends BaseConfig>
public void setRow(NumberType r)
setRow
in interface Coordinates
setRow
in class GenericWidget<T extends BaseConfig>
r
- The 1-based row number at which to start displaying the
widget. This is converted to a 0-based row number for the
internal runtime.public void setRow(double r)
setRow
in interface Coordinates
setRow
in class GenericWidget<T extends BaseConfig>
r
- The 1-based row number at which to start displaying the
widget. This is converted to a 0-based row number for the
internal runtime.public logical isSelected()
isSelected
in interface CommonWidget
isSelected
in class GenericWidget<T extends BaseConfig>
public void setSelected(logical sel)
setSelected
in interface CommonWidget
setSelected
in class GenericWidget<T extends BaseConfig>
sel
- The new value for the SELECTED attribute.public void setSelected(boolean sel)
setSelected
in interface CommonWidget
setSelected
in class GenericWidget<T extends BaseConfig>
sel
- The new value for the SELECTED attribute.public character getTitle()
getTitle
in interface CommonWidget
getTitle
in class GenericWidget<T extends BaseConfig>
public void setTitle(character title)
setTitle
in interface CommonWidget
setTitle
in class GenericWidget<T extends BaseConfig>
title
- The new value for the TITLE attribute.public void setTitle(java.lang.String title)
setTitle
in interface CommonWidget
setTitle
in class GenericWidget<T extends BaseConfig>
title
- The new value for the TITLE attribute.public character getTooltip()
getTooltip
in interface CommonWidget
getTooltip
in class GenericWidget<T extends BaseConfig>
public integer getX()
getX
in interface Coordinates
getX
in class GenericWidget<T extends BaseConfig>
public void setX(NumberType x)
setX
in interface Coordinates
setX
in class GenericWidget<T extends BaseConfig>
x
- The new value for the X attribute.public void setX(int x)
setX
in interface Coordinates
setX
in class GenericWidget<T extends BaseConfig>
x
- The new value for the X attribute.public integer getY()
getY
in interface Coordinates
getY
in class GenericWidget<T extends BaseConfig>
public void setY(NumberType y)
setY
in interface Coordinates
setY
in class GenericWidget<T extends BaseConfig>
y
- The new value for the Y attribute.public void setY(int y)
setY
in interface Coordinates
setY
in class GenericWidget<T extends BaseConfig>
y
- The new value for the Y attribute.public void setTooltip(java.lang.String tooltip)
setTooltip
in interface CommonWidget
setTooltip
in class GenericWidget<T extends BaseConfig>
tooltip
- new value of TOOLTIP attributepublic void setTooltip(character tooltip)
setTooltip
in interface CommonWidget
setTooltip
in class GenericWidget<T extends BaseConfig>
tooltip
- new value of TOOLTIP attributepublic void setWidthPixels(NumberType widthPixels)
setWidthPixels
in interface Sizeable
setWidthPixels
in class GenericWidget<T extends BaseConfig>
widthPixels
- The new value for the WIDTH-PIXELS attribute.public void setWidthPixels(int widthPixels)
setWidthPixels
in interface Sizeable
setWidthPixels
in class GenericWidget<T extends BaseConfig>
widthPixels
- The new value for the WIDTH-PIXELS attribute.public void setHeightPixels(NumberType heightPixels)
setHeightPixels
in interface Sizeable
setHeightPixels
in class GenericWidget<T extends BaseConfig>
heightPixels
- new value of HEIGHT-PIXELS attributepublic void setHeightPixels(int heightPixels)
setHeightPixels
in interface Sizeable
setHeightPixels
in class GenericWidget<T extends BaseConfig>
heightPixels
- new value of HEIGHT-PIXELS attributepublic void setFont(int64 fontNum)
setFont
in interface CommonWidget
setFont
in class GenericWidget<T extends BaseConfig>
fontNum
- An entry in the font-table or unknown to refer the default font.public integer getFont()
getFont
in interface CommonWidget
getFont
in class GenericWidget<T extends BaseConfig>
public void setTabStop(boolean value)
setTabStop
in interface CommonWidget
setTabStop
in class GenericWidget<T extends BaseConfig>
value
- Value of the attribute.public void setTabStop(logical value)
setTabStop
in interface CommonWidget
setTabStop
in class GenericWidget<T extends BaseConfig>
value
- Value of the attribute.public logical isTabStop()
isTabStop
in interface CommonWidget
isTabStop
in class GenericWidget<T extends BaseConfig>
public decimal getFrameColumn()
getFrameColumn
in interface CommonWidget
getFrameColumn
in class GenericWidget<T extends BaseConfig>
public decimal getFrameRow()
getFrameRow
in interface CommonWidget
getFrameRow
in class GenericWidget<T extends BaseConfig>
public integer getFrameX()
getFrameX
in interface CommonWidget
getFrameX
in class GenericWidget<T extends BaseConfig>
public integer getFrameY()
getFrameY
in interface CommonWidget
getFrameY
in class GenericWidget<T extends BaseConfig>
public character getFontName()
getFontName
in interface CustomFont
public void setFontName(character name)
setFontName
in interface CustomFont
name
- the attribute valuepublic integer getFontSize()
getFontSize
in interface CustomFont
public void setFontSize(NumberType size)
setFontSize
in interface CustomFont
size
- the attribute valuepublic logical isFontBold()
isFontBold
in interface CustomFont
public void setFontBold(logical value)
setFontBold
in interface CustomFont
value
- the attribute valuepublic logical isFontItalic()
isFontItalic
in interface CustomFont
public void setFontItalic(logical value)
setFontItalic
in interface CustomFont
value
- the attribute valuepublic logical isFontUnderline()
isFontUnderline
in interface CustomFont
public void setFontUnderline(logical value)
setFontUnderline
in interface CustomFont
value
- the attribute valuepublic FontInfo getFontInfo()
FontInfo
. The property reads and writes
on the returned instance will be forwarded to this class.getFontInfo
in interface CustomFont
FontInfo
.protected void changeFontWorker(int font)
font
- Valid font value.protected boolean validateSize(java.lang.Number value, SizeAttribute attr)
value
- The input value to validate.attr
- Denotes the kind of size attribute.true
when valid, false
otherwiseprotected boolean useHandleChainSiblings()
HandleChain
is used,
FALSE - if own siblings implementation logic is used.protected void resetAutoResize()
protected void setWidthCharsWorker(double width)
width
- Valid width value.protected void setHeightCharsWorker(double height)
height
- Valid height value.protected void setWidthPixelsWorker(int width)
width
- Valid width value.protected void setHeightPixelsWorker(int height)
height
- Valid height value.protected void setMinWidthCharsWorker(double width)
width
- Valid width value.protected void setMinHeightCharsWorker(double height)
height
- Valid height value.protected void setMinWidthPixelsWorker(int width)
width
- Valid width value.protected void setMinHeightPixelsWorker(int height)
height
- Valid height value.protected void setMaxWidthCharsWorker(double width)
width
- Valid width value.protected void setMaxHeightCharsWorker(double height)
height
- Valid height value.protected void setMaxWidthPixelsWorker(int width)
width
- Valid width value.protected void setMaxHeightPixelsWorker(int height)
height
- Valid height value.protected void setVirtWidthCharsWorker(double width)
width
- Valid width value.protected void setVirtHeightCharsWorker(double height)
height
- Valid height value.protected void setVirtWidthPixelsWorker(int width)
width
- Valid width value.protected void setVirtHeightPixelsWorker(int height)
height
- Valid height value.protected void setColumnOrRowWorker(boolean isUnknown, double value, boolean row)
Sub-classes can override this method; at this point, the parameters are valid.
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 final void pushLocAttrs(boolean row)
row
- Flag indicating if we are pushing row location or column.protected void setXOrYWorker(boolean isUnknown, int value, boolean x)
Sub-classes can override this method; at this point, the parameters are valid.
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.protected boolean canSetPixelPositionInChui()
true
if this entity accepts assignment of X or Y
attributes in ChUI mode. If the method returns false
, error 4079
is emitted when these attributes are assigned.
The default implementation always returns true
.
protected boolean validColumnOrRow(boolean isUnknown, double value, boolean row)
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.true
if the given value is valid for the row or col attribute.protected void setColumnOrRow(boolean isUnknown, double value, boolean row)
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 setXorY(boolean isUnknown, int value, boolean x)
isUnknown
- If true
the attribute value being set is an unknown value.value
- The X or Y position value.x
- If true
value
represents an X position, otherwise
a Y position.protected void setSizeChars(java.lang.Double value, SizeAttribute attr)
value
- The attribute value. null
denotes an unknown attribute value.attr
- The attribute being set.protected void setSizePixels(java.lang.Integer value, SizeAttribute attr)
value
- The attribute value. null
denotes an unknown attribute value.attr
- The attribute being set.protected boolean validateParent(GenericWidget<?> widget)
widget
- The widget reference to check.true
if the supplied widget can be used
as a valid parent, false
otherwise.protected java.lang.String[] getValidParentTypes()
protected void getSizeAttrs(java.util.List<java.lang.String> names, java.util.List<java.lang.Object> vals)
names
- The collection where to add the field names.vals
- The collection where to add the field values.protected void pushSizeAttrs()
protected decimal _getWidthChars()
protected void setWidthImpl(int widthPixels, SizeAttribute attribute)
setWidthPixels(int)
and setWidthChars(double)
.widthPixels
- the new widget width in pixels, must be positiveattribute
- attribute for reporting purposesprotected void setHeightImpl(int heightPixels, SizeAttribute attribute)
setHeightPixels(int)
and setHeightChars(double)
.heightPixels
- the new widget height in pixels, must be positiveattribute
- attribute for reporting purposesprotected decimal _getHeightChars()
protected integer _getWidthPixels()
protected integer _getHeightPixels()
protected final void emit4084Warning(SizeAttribute attribute)
attribute
- the attribute to reportprotected final void emitUnableToAssignUnknownAttributeWarning(SizeAttribute attribute)
attribute
- the attribute to reportprivate final void emitNonPositiveAttributeWarning(int code, SizeAttribute attribute)
code
- error code, expected values are 4084 and 4082attribute
- the attribute to reportprivate boolean isRedirected()
private boolean isInsideSetup()