com.goldencode.p2j.ui

Class ControlEntity<T extends ControlConfig>

java.lang.Object

com.goldencode.p2j.util.HandleResource

com.goldencode.p2j.util.HandleChain

com.goldencode.p2j.ui.GenericWidget<T>

com.goldencode.p2j.ui.BaseEntity<T>

com.goldencode.p2j.ui.ControlEntity<T>

Type Parameters:

T - config type

All Implemented Interfaces:

AutoResizableWidget, Checkable, CommonWidget, ConfigOwner<T>, CustomFont, DisableRedraw, Droppable, ImageSupport, ImageWidgetSupport, IndexedInterface, WidgetTree, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable

Direct Known Subclasses:

ButtonListGroupItemWidget, ButtonWidget, ControlEntityExt, ControlFrameWidget, ControlSetEntity, ControlTextWidget, HtmlBrowserWidget, RectangleWidget, SignatureWidget, SliderWidget, TabSetWidget, ToggleBoxWidget

public abstract class ControlEntity<T extends ControlConfig>
extends BaseEntity<T>
implements IndexedInterface, AutoResizableWidget, Droppable, WidgetTree

Represents widget functionality that is associated with all widgets that represent data OR which provide a control feature (like a button).

Nested Class Summary

Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity

BaseEntity.CharsPixels

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALIGN_COLON Alignment mode - align widget to label colon
static int	ALIGN_LEFT Alignment mode - align widget left
static int	ALIGN_RIGHT Alignment mode - align widget right
private java.lang.Class<?>	dataTypeClass Type of the variable in the widget.
private TextBasedWidget	sideLabelWidget Reference to the side-label widget (as returned by the SIDE-LABEL-HANDLE).

Fields inherited from class com.goldencode.p2j.ui.BaseEntity

group

Fields inherited from class com.goldencode.p2j.ui.GenericWidget

config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess

Fields inherited from class com.goldencode.p2j.util.HandleChain

name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource

instProc, pm

Constructor Summary

Constructors

Constructor and Description
ControlEntity(boolean dynamic, T ctrl) Constructor for use by sub-classes.

Method Summary

Modifier and Type	Method and Description
protected void	changeFontWorker(int font) Sets the value for the FONT attribute.
void	delete() Perform actual delete of an resource.
GenericWidget<?>	firstChild() Accesses the first widget in the group of related widgets.
decimal	getColon() Gets the column number to which colon between label and widget should be aligned.
java.lang.Class<?>	getDataClass() Accesses the data type which the widget represents.
character	getDataType() Queries the DATA-TYPE attribute of this widget.
integer	getIndex() Get current value of the INDEX attribute.
handle	getNextTabItem() Getter for the NEXT-TAB-ITEM read-only attribute.
handle	getPreviousTabItem() Getter for the PREV-TAB-ITEM read-only attribute.
handle	getPrevSibling() Obtains the previous sibling widget in the current field group.
protected handle	getSideLabelHandleWorker() Obtains the text widget that is used as the side label for this widget.
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() Blocks attempts to get the TITLE attribute as it is undefined.
protected boolean	hasSideLabelHandle() Check if a side-label can be attached.
logical	isAutoResize() Get current value of the AUTO-RESIZE attribute.
logical	isDropTarget() Gets DROP-TARGET attribute.
logical	isModified() Queries if the SCREEN-VALUE attribute for this widget was changed.
GenericWidget<?>	lastChild() Accesses the last widget in the group of related widgets.
protected int	processSideLabel(boolean explicit) Process the side-label for this widget.
void	resetAutoResize() Set AUTO-RESIZE to false;
void	setAttrSpace(boolean attrSpace) Sets the value of the ATTR-SPACE attribute.
void	setAutoResize(boolean autoResize) Set AUTO-RESIZE attribute value.
void	setAutoResize(logical autoResize) Set AUTO-RESIZE attribute value.
void	setColumnLabel(character clabel) Sets the column label.
void	setColumnLabel(java.lang.String clabel) Sets the column label.
void	setDataType(character dataType) Sets new value of DATA-TYPE attribute.
void	setDataType(java.lang.String dataType) Set type of the bound variable.
void	setDropTarget(boolean flag) Sets DROP-TARGET attribute.
void	setForceLabel(boolean force) Force displaying of label.
void	setForceLabel(logical force) Force displaying of label.
protected void	setHeightCharsWorker(double height) The method that actually performs assignment of the HEIGHT-CHARS attribute.
protected void	setHeightPixelsWorker(int heightPixels) The method that actually performs assignment of the HEIGHT-PIXELS attribute.
void	setIndex(int index) Set INDEX attribute value.
void	setIndex(NumberType index) Set INDEX attribute value.
void	setModified(boolean modified) Defines if the SCREEN-VALUE attribute for this widget has changed.
void	setModified(logical modified) Defines if the SCREEN-VALUE attribute for this widget has changed.
void	setNoAttrSpace(boolean noAttrSpace) Sets the value of the NO-ATTR-SPACE attribute.
void	setNoLabels(boolean noLabels) Set new value to NO-LABELS flag.
protected void	setSideLabelHandleWorker(handle label) Sets the text widget that is used as the side label for this widget.
void	setTitle(character t) Blocks attempts to set the TITLE attribute as it is undefined.
void	setTitle(java.lang.String t) Blocks attempts to set the TITLE attribute as it is undefined.
void	setTo(double pos) Sets the rightmost column of the widget.
void	setTo(NumberType pos) Sets the rightmost column of the widget.
protected void	setWidthCharsWorker(double width) The method that actually performs assignment of the WIDTH-CHARS attribute.
protected void	setWidthPixelsWorker(int widthPixels) The method that actually performs assignment of the WIDTH=PIXELS attribute.
protected logical	validateFields(boolean enabledOnly) Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.

Methods inherited from class com.goldencode.p2j.ui.BaseEntity

_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getParent, getPfColor, getRow, getTooltip, getValidParentTypes, getWidthChars, getWidthPixels, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightImpl, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthChars, setWidthChars, setWidthImpl, setWidthPixels, setWidthPixels, setX, setX, setXorY, setXOrYWorker, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget

_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _name, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, 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, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, 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, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMultiple, isNotEntered, isReadOnly, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, 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, 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, setFromOCX, 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, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, 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, type, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain

firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource

_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.Droppable

endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget

getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain

getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

id, id, unknown

Methods inherited from interface com.goldencode.p2j.util.Nameable

name, name

Methods inherited from interface com.goldencode.p2j.ui.DisableRedraw

setDisableRedraw

Methods inherited from interface com.goldencode.p2j.ui.WriteProtectable

setReadOnly

Methods inherited from interface com.goldencode.util.Printable

asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable

allowDelete

Field Detail

ALIGN_LEFT

public static final int ALIGN_LEFT

Alignment mode - align widget left

See Also:

Constant Field Values

ALIGN_RIGHT

public static final int ALIGN_RIGHT

Alignment mode - align widget right

See Also:

Constant Field Values

ALIGN_COLON

public static final int ALIGN_COLON

Alignment mode - align widget to label colon

See Also:

Constant Field Values

dataTypeClass

private java.lang.Class<?> dataTypeClass

Type of the variable in the widget.

sideLabelWidget

private TextBasedWidget sideLabelWidget

Reference to the side-label widget (as returned by the SIDE-LABEL-HANDLE). When null, it means no side-label exists (thus SIDE-LABEL-HANDLE is unknown).

Constructor Detail

ControlEntity

public ControlEntity(boolean dynamic,
                     T ctrl)

Constructor for use by sub-classes.

Parameters:

dynamic - Flag indicating if this is a static or dynamic resource.

ctrl - Configuration container.

Method Detail

getDataClass

public java.lang.Class<?> getDataClass()

Accesses the data type which the widget represents.

Returns:

The class of the value that the widget represents or null if this widget does not represent any data (e.g. the widget is a button).

setColumnLabel

public void setColumnLabel(character clabel)

Sets the column label.

Specified by:

setColumnLabel in interface CommonField

Overrides:

setColumnLabel in class GenericWidget<T extends ControlConfig>

Parameters:

clabel - column label text

setColumnLabel

public void setColumnLabel(java.lang.String clabel)

Sets the column label.

Specified by:

setColumnLabel in interface CommonField

Overrides:

setColumnLabel in class GenericWidget<T extends ControlConfig>

Parameters:

clabel - column label text

setForceLabel

public void setForceLabel(logical force)

Force displaying of label.

Parameters:

force - New value for the flag.

setForceLabel

public void setForceLabel(boolean force)

Force displaying of label.

Parameters:

force - New value for the flag.

getNextTabItem

public handle getNextTabItem()

Getter for the NEXT-TAB-ITEM read-only attribute.

Specified by:

getNextTabItem in interface CommonWidget

Overrides:

getNextTabItem in class GenericWidget<T extends ControlConfig>

Returns:

The value of the NEXT-TAB-ITEM attribute.

getPreviousTabItem

public handle getPreviousTabItem()

Getter for the PREV-TAB-ITEM read-only attribute.

Specified by:

getPreviousTabItem in interface CommonWidget

Overrides:

getPreviousTabItem in class GenericWidget<T extends ControlConfig>

Returns:

The value of the PREV-TAB-ITEM attribute.

setTo

public void setTo(NumberType pos)

Sets the rightmost column of the widget.

Parameters:

pos - The 1-based column number. This is converted to a 0-based column number for the internal runtime.

setTo

public void setTo(double pos)

Sets the rightmost column of the widget.

Parameters:

pos - The 1-based column number. This is converted to a 0-based column number for the internal runtime.

getColon

public decimal getColon()

Gets the column number to which colon between label and widget should be aligned. Note that Progress does not have corresponding attribute so calls to this method are unlikely.

Returns:

The 1-based column of the desired colon position. This is converted from a 0-based column number for the internal runtime.

setDataType

public void setDataType(character dataType)

Sets new value of DATA-TYPE attribute.

Specified by:

setDataType in interface CommonField

Overrides:

setDataType in class GenericWidget<T extends ControlConfig>

Parameters:

dataType - new value of DATA-TYPE attribute

setDataType

public void setDataType(java.lang.String dataType)

Set type of the bound variable.

Specified by:

setDataType in interface CommonField

Overrides:

setDataType in class GenericWidget<T extends ControlConfig>

Parameters:

dataType - New data type name.

getDataType

public character getDataType()

Queries the DATA-TYPE attribute of this widget.

Specified by:

getDataType in interface CommonField

Overrides:

getDataType in class GenericWidget<T extends ControlConfig>

Returns:

A character value that represents the data type of the field associated with the widget.

isModified

public logical isModified()

Queries if the SCREEN-VALUE attribute for this widget was changed.

Specified by:

isModified in interface CommonWidget

Overrides:

isModified in class GenericWidget<T extends ControlConfig>

Returns:

If true, the widget's screen value was changed.

setModified

public void setModified(boolean modified)

Defines if the SCREEN-VALUE attribute for this widget has changed.

Specified by:

setModified in interface CommonWidget

Overrides:

setModified in class GenericWidget<T extends ControlConfig>

Parameters:

modified - true to mark the screen value as changed.

setModified

public void setModified(logical modified)

Defines if the SCREEN-VALUE attribute for this widget has changed.

Specified by:

setModified in interface CommonWidget

Overrides:

setModified in class GenericWidget<T extends ControlConfig>

Parameters:

modified - true to mark the screen value as changed.

setNoLabels

public void setNoLabels(boolean noLabels)

Set new value to NO-LABELS flag.

Parameters:

noLabels - New value of the flag.

setAttrSpace

public void setAttrSpace(boolean attrSpace)

Sets the value of the ATTR-SPACE attribute.

Parameters:

attrSpace - The new boolean value for the ATTR-SPACE attribute.

setNoAttrSpace

public void setNoAttrSpace(boolean noAttrSpace)

Sets the value of the NO-ATTR-SPACE attribute.

Parameters:

noAttrSpace - The new boolean value for the NO-ATTR-SPACE attribute.

getTitle

public character getTitle()

Blocks attempts to get the TITLE attribute as it is undefined.

Specified by:

getTitle in interface CommonWidget

Overrides:

getTitle in class BaseEntity<T extends ControlConfig>

Returns:

Always throws RuntimeException.

setTitle

public void setTitle(character t)

Blocks attempts to set the TITLE attribute as it is undefined.

Specified by:

setTitle in interface CommonWidget

Overrides:

setTitle in class BaseEntity<T extends ControlConfig>

Parameters:

t - Unused.

setTitle

public void setTitle(java.lang.String t)

Blocks attempts to set the TITLE attribute as it is undefined.

Specified by:

setTitle in interface CommonWidget

Overrides:

setTitle in class BaseEntity<T extends ControlConfig>

Parameters:

t - Unused.

setIndex

public void setIndex(int index)

Set INDEX attribute value.

Parameters:

index - New value for the attribute.

setIndex

public void setIndex(NumberType index)

Set INDEX attribute value.

Parameters:

index - New value for the attribute.

getIndex

public integer getIndex()

Get current value of the INDEX attribute.

Specified by:

getIndex in interface IndexedInterface

Returns:

The current value of the attribute.

isAutoResize

public logical isAutoResize()

Get current value of the AUTO-RESIZE attribute.

Specified by:

isAutoResize in interface CommonWidget

Overrides:

isAutoResize in class GenericWidget<T extends ControlConfig>

Returns:

The current value of the attribute.

setAutoResize

public void setAutoResize(logical autoResize)

Set AUTO-RESIZE attribute value.

Specified by:

setAutoResize in interface CommonWidget

Overrides:

setAutoResize in class GenericWidget<T extends ControlConfig>

Parameters:

autoResize - New value for the attribute.

setAutoResize

public void setAutoResize(boolean autoResize)

Set AUTO-RESIZE attribute value.

Specified by:

setAutoResize in interface CommonWidget

Overrides:

setAutoResize in class GenericWidget<T extends ControlConfig>

Parameters:

autoResize - New value for the attribute.

resetAutoResize

public void resetAutoResize()

Set AUTO-RESIZE to false;

Specified by:

resetAutoResize in interface AutoResizableWidget

Overrides:

resetAutoResize in class BaseEntity<T extends ControlConfig>

isDropTarget

public logical isDropTarget()

Gets DROP-TARGET attribute.

Specified by:

isDropTarget in interface Droppable

Returns:

DROP-TARGET current value.

setDropTarget

public void setDropTarget(boolean flag)

Sets DROP-TARGET attribute.

Specified by:

setDropTarget in interface Droppable

Parameters:

flag - New value for the attribute.

firstChild

public GenericWidget<?> firstChild()

Accesses the first widget in the group of related widgets.

Specified by:

firstChild in interface WidgetTree

Returns:

An instance of GenericWidget, may be this object.

lastChild

public GenericWidget<?> lastChild()

Accesses the last widget in the group of related widgets.

Specified by:

lastChild in interface WidgetTree

Returns:

An instance of GenericWidget, may be this object.

getPrevSibling

public handle getPrevSibling()

Obtains the previous sibling widget in the current field group.

Specified by:

getPrevSibling in interface CommonHandleChain

Overrides:

getPrevSibling in class BaseEntity<T extends ControlConfig>

Returns:

The previous sibling or an unknown handle if this only widget or if this is the first widget.

delete

public void delete()

Perform actual delete of an resource. At the time of this call, it is assumed the resource is valid for deletion (the handle and the resource are both valid).

The method first calls GenericWidget.resourceDelete(), if the method returns false, the deletion is aborted.

Specified by:

delete in interface Deletable

Overrides:

delete in class GenericWidget<T extends ControlConfig>

getSideLabelHandleWorker

protected handle getSideLabelHandleWorker()

Obtains the text widget that is used as the side label for this widget. This is the equivalent of the SIDE-LABEL-HANDLE attribute of COMBO-BOX, EDITOR, FILL-IN, RADIO-SET, SELECTION-LIST, SLIDER and TEXT widgets.

Returns:

The handle to the text widget that is the side label of this widget.

setSideLabelHandleWorker

protected void setSideLabelHandleWorker(handle label)

Sets the text widget that is used as the side label for this widget. This is the equivalent of the SIDE-LABEL-HANDLE attribute of COMBO-BOX, EDITOR, FILL-IN, RADIO-SET, SELECTION-LIST, SLIDER and TEXT widgets.

Parameters:

label - The handle to the text widget to be used as the side label of this widget.

changeFontWorker

protected void changeFontWorker(int font)

Sets the value for the FONT attribute. Only valid width values must be passed in the font argument.

Overrides:

changeFontWorker in class BaseEntity<T extends ControlConfig>

Parameters:

font - Valid font value.

setHeightCharsWorker

protected void setHeightCharsWorker(double height)

The method that actually performs assignment of the HEIGHT-CHARS attribute.

Overrides:

setHeightCharsWorker in class BaseEntity<T extends ControlConfig>

Parameters:

height - The attribute value.

setWidthCharsWorker

protected void setWidthCharsWorker(double width)

The method that actually performs assignment of the WIDTH-CHARS attribute.

Overrides:

setWidthCharsWorker in class BaseEntity<T extends ControlConfig>

Parameters:

width - The attribute value.

setWidthPixelsWorker

protected void setWidthPixelsWorker(int widthPixels)

The method that actually performs assignment of the WIDTH=PIXELS attribute.

Overrides:

setWidthPixelsWorker in class BaseEntity<T extends ControlConfig>

Parameters:

widthPixels - The attribute value.

setHeightPixelsWorker

protected void setHeightPixelsWorker(int heightPixels)

The method that actually performs assignment of the HEIGHT-PIXELS attribute.

Overrides:

setHeightPixelsWorker in class BaseEntity<T extends ControlConfig>

Parameters:

heightPixels - The attribute value.

getSizeAttrs

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.

Overrides:

getSizeAttrs in class BaseEntity<T extends ControlConfig>

Parameters:

names - The collection where to add the field names.

vals - The collection where to add the field values.

hasSideLabelHandle

protected boolean hasSideLabelHandle()

Check if a side-label can be attached.

This is possible only if the widget accepts a side-label the (ControlConfig.possibleSideLabel flag is true) and also the frame is configured with the SIDE-LABELS option.

Returns:

true if the SIDE-LABEL-HANDLE needs to return a valid handle.

processSideLabel

protected int processSideLabel(boolean explicit)

Process the side-label for this widget.

If the widget accepts a side-label, it will construct it if sideLabelWidget is not already set.

Overrides:

processSideLabel in class GenericWidget<T extends ControlConfig>

Parameters:

explicit - true if this label is explicitly set via the LABEL attribute.

Returns:

The ID for the side-label widget (as reported by ControlConfig.sideLabelId) or -1 if none exists.

validateFields

protected logical validateFields(boolean enabledOnly)

Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied. This is used to check if a proposed update to an object will pass validation.

Overrides:

validateFields in class GenericWidget<T extends ControlConfig>

Parameters:

enabledOnly - If true, VALIDATE will check enabled fields only. Otherwise, the VALIDATE method validates all fields, whether enabled or not.

Returns:

true if the validation is successful.