GenericWidget (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.ui.GenericWidget<T>

Type Parameters:

T - configuration type.

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseEntity, SkipEntity
```
public abstract class GenericWidget<T extends WidgetConfig>
extends HandleChain
implements CommonWidget, Sensitive, DynamicResource, ConfigOwner<T>, Checkable
```
This class represents server side widgets. Every widget is associated with its configuration object, which is embedded into the widget. The widget constructors create and initialize their backing configuration objects.

Field Summary

Fields
Modifier and Type	Field and Description
`protected T`	`config` The configuration container.
`private static boolean`	`configBatchingDisabled` When `true` config field changes batching is disabled.
`private WidgetConfigDef`	`configDef` The cached config definition for the widget's config
`private java.lang.String`	`dbName` The value of the DBNAME attribute.
`private java.lang.String`	`defaultHelp` Holds default (schema) help message if any is defined in database.
`protected boolean`	`deleted` Flag indicating the resource was deleted.
`private boolean`	`dynamic` When `true`, marks this resource as being dynamically created.
`protected GenericFrame`	`frame` The containing frame object.
`private boolean`	`frameLock` When set, all attribute assignments are cached on server-side and pushed to client-side only when the lock is set to `false` via `setScreenLock(boolean)`.
`protected boolean`	`internalScreenValueUsage` Flag indicating if the `setScreenValue(com.goldencode.p2j.util.character)` is being called from the converted code or from within FWD.
`private boolean`	`isDefaultHelp` `true` if the currently displayed help is the default(overrideable) schema help.
`private LogicalTerminal`	`logicalTerminal` Cached logical terminal instance
`private MenuWidget`	`menu` MenuWidget handle owned by this widget
`private character`	`pendingScreenValue` Holds the SCREEN-VALUE until the parent frame is set.
`protected boolean`	`realizeOnAttributeAccess` Flag indicating if the widget must be realized on attribute access.
`private java.lang.String`	`saveConfigHelp` Saved value for the widget's config `help` field; used for imported shared frames only.
`private java.lang.String`	`saveDefaultHelp` Saved value for `defaultHelp` field; used for imported shared frames only.
`private boolean`	`saveIsDefaultHelp` Saved value for `isDefaultHelp` field; used for imported shared frames only.
`private ValidationExpr`	`saveValexp` Saved value for `valexp` field; used for imported shared frames only.
`private ValidationMsg`	`saveValmsg` Saved value for `valmsg` field; used for imported shared frames only.
`private static boolean`	`selectiveConfigFlushDisabled` When `true` selective config flushing is disabled.
`private boolean`	`sharedStateSaved` Flag indicating if shared state was saved or not.
`private java.lang.String`	`tableName` The value of the TABLE attribute.
`private ValidationExpr`	`valexp` The validation expression to use to test proposed edits for this widget.
`private ValidationMsg`	`valmsg` The expression to generate an error message when validation fails.

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
`GenericWidget(boolean dynamic, T config)` Constructor.
`GenericWidget(boolean dynamic, T config, GenericWidget<T> before, boolean firstAsLast)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`_dynamic()` Checks whether the resource is dynamic or static.
`java.lang.String`	`_getDbName()` Returns the state of the DBNAME attribute in non-wrapped form.
`java.lang.String`	`_getFormat()` Gets the format specification.
`java.lang.String`	`_getTable()` Returns the state of the TABLE attribute in non-wrapped form.
`boolean`	`_isEntered()` Checks whether the widget was changed during the most recent editing operation.
`boolean`	`_isHidden()` Gets the HIDDEN writable attribute.
`boolean`	`_isNotEntered()` Checks whether the widget was changed during the most recent editing operation.
`boolean`	`_isRealized()` Returns a flag indicating whether the widget has been realized.
`boolean`	`_isVisible()` Get the VISIBLE writable attribute.
`java.lang.String`	`_name()` Get the `name` attribute of handle as a string.
`void`	`_setDynamic(boolean dynFlag)` Set the dynamic status of this widget.
`protected void`	`_setVisible(boolean visible)` Sets the widget's config `visibility flag`.
`void`	`afterConfigUpdate(T beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`void`	`apply(character event)` Applies an event to this widget.
`void`	`apply(double eventCode)` Applies an event to this widget.
`void`	`apply(int64 eventCode)` Applies an event to this widget.
`void`	`apply(java.lang.String event)` Applies an event to this widget.
`handle`	`asWidgetHandle()` Get this widget wrapped in a handle.
`protected boolean`	`canAccess(java.lang.String attr)` Check if can access attribute
`protected boolean`	`canDelete()` Check if this resource can be deleted (implicitly or not).
`protected boolean`	`canPushWidgetAttr()` Returns true if the configuration can be pushed to the client-side.
`void`	`cleanup()` Cleanup the dynamic widget before deletion.
`void`	`colorDisplay(ColorSpec cs)` COLOR DISPLAY
`void`	`colorPrompt(ColorSpec cs)` COLOR PROMPT
`T`	`config()` Gets the configuration object that defines the appearance and functioning of this widget.
`void`	`delete()` Perform actual delete of an resource.
`logical`	`deselectRows()` Blocks attempts to access this widget method.
`(package private) void`	`detachMenu(MenuWidget menu)` Detach the specified popup-menu from this widget.
`void`	`disable()` Disables this widget.
`logical`	`dynamic()` Checks whether the resource is dynamic or static.
`logical`	`editUndo()` Blocks attempts to access this widget method.
`void`	`enable()` Enables this widget.
`private void`	`enqueuWidgetAttr(int widgetId, java.lang.String fname, java.lang.Object value)` Enqueues widget attribute assignment.
`protected void`	`finishConfigProcessing()` Finish the config processing for this widget.
`void`	`finishSetup()` Finish initialization of the widget.
`void`	`flushWidgetAttrs()` Performs explicit flush of enqueued config changes.
`protected void`	`genAssignUnknownWarning(java.lang.String attr)` Generate the "Unable to assign UNKNOWN value to attribute" warning (4083).
`boolean`	`getAttr(java.lang.String fname, java.util.function.BooleanSupplier getter)` Returns config field value.
`boolean`	`getAttr(java.lang.String fname, java.util.function.BooleanSupplier getter, boolean flush)` Returns config field value.
`char`	`getAttr(java.lang.String fname, CharSupplier getter)` Returns config field value.
`char`	`getAttr(java.lang.String fname, CharSupplier getter, boolean flush)` Returns config field value.
`double`	`getAttr(java.lang.String fname, java.util.function.DoubleSupplier getter)` Returns config field value.
`double`	`getAttr(java.lang.String fname, java.util.function.DoubleSupplier getter, boolean flush)` Returns config field value.
`int`	`getAttr(java.lang.String fname, java.util.function.IntSupplier getter)` Returns config field value.
`int`	`getAttr(java.lang.String fname, java.util.function.IntSupplier getter, boolean flush)` Returns config field value.
`long`	`getAttr(java.lang.String fname, java.util.function.LongSupplier getter)` Returns config field value.
`long`	`getAttr(java.lang.String fname, java.util.function.LongSupplier getter, boolean flush)` Returns config field value.
`<T> T`	`getAttr(java.lang.String fname, java.util.function.Supplier<T> getter)` Returns config field value.
`<T> T`	`getAttr(java.lang.String fname, java.util.function.Supplier<T> getter, boolean flush)` Returns config field value.
`integer`	`getBgColor()` Blocks attempts to access this attribute.
`integer`	`getBgColorRgb()` Blocks attempts to access this attribute.
`decimal`	`getColumn()` Blocks attempts to access this attribute.
`integer`	`getColumnFont()` Get the COLUMN-FONT attribute of this browse column widget.
`character`	`getColumnLabel()` Getter of COLUMN-LABEL attribute.
`integer`	`getContextHelpId()` Gets the CONTEXT-HELP-ID writable attribute.
`logical`	`getConvert3D()` Gets CONVERT-3D-COLORS attribute.
`integer`	`getCursorOffset()` Obtains the index position of the cursor in a text editing widget.
`character`	`getDataType()` Queries the DATA-TYPE attribute of this widget.
`character`	`getDbName()` Returns the state of the DBNAME attribute.
`integer`	`getDColor()` Blocks attempts to access this attribute.
`integer`	`getFgColor()` Blocks attempts to access this attribute.
`integer`	`getFgColorRgb()` Blocks attempts to access this attribute.
`integer`	`getFont()` Get the FONT attribute of this widget.
`character`	`getFormat()` Gets the format specification.
`GenericFrame`	`getFrame()` Gets the containing frame instance.
`decimal`	`getFrameColumn()` Blocks attempts to access this attribute.
`handle`	`getFrameHandle()` Gets the containing frame instance, as a handle.
`character`	`getFrameName()` Gets the frame name.
`decimal`	`getFrameRow()` Gets the FRAME-ROW attribute.
`integer`	`getFrameX()` Blocks attempts to access this attribute.
`integer`	`getFrameY()` Blocks attempts to access this attribute.
`decimal`	`getHeight()` Get the HEIGHT Progress attribute.
`decimal`	`getHeightChars()` Blocks attempts to access this attribute.
`integer`	`getHeightPixels()` Queries the HEIGHT-PIXELS attribute of this widget.
`character`	`getHelp()` Get the HELP writable attribute.
`integer`	`getHWND()` Gets the integer value of the window containing the widget.
`int`	`getId()` Gets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).
`character`	`getImage()` Blocks attempts to access this attribute.
`character`	`getLabel()` Get the label text for this widget.
`integer`	`getLabelFont()` Get the LABEL-FONT attribute of this browse column widget.
`java.lang.String`	`getLabelStr()` Get the label text for this widget.
`protected LogicalTerminal`	`getLogicalTerminal()` Returns logical terminal instance.
`decimal`	`getMaxHeightChars()` Blocks attempts to access this attribute.
`decimal`	`getMaxWidthChars()` Blocks attempts to access this attribute.
`character`	`getMenuKey()` Gets the MENU-KEY attribute.
`integer`	`getMenuMouse()` Gets the MENU-MOUSE attribute.
`character`	`getMousePointer()` Get the value of the MOUSE-POINTER attribute for a widget
`integer[]`	`getMousePosition()` Returns current mouse cursor position relative to this widget.
`handle`	`getNextTabItem()` Calculates the next widget in the tab order.
`integer`	`getNumColumns()` Blocks attempts to access this widget method.
`integer`	`getNumSelectedRows()` Blocks attempts to access this attribute.
`CommonWidget`	`getParent()` Blocks attempts to access this attribute.
`handle`	`getParentHandle()` Gets the PARENT attribute, as a handle.
`integer`	`getPfColor()` Blocks attempts to access this attribute.
`handle`	`getPopupMenu()` Get widget POPUP-MENU.
`handle`	`getPreviousTabItem()` Calculates the previous widget in the tab order.
`P2JQuery`	`getQuery()` Blocks attempts to access this attribute.
`logical`	`getRetainShape()` Gets RETAIN-SHAPE attribute.
`decimal`	`getRow()` Blocks attempts to access this attribute.
`character`	`getScreenValue()` Obtain the current value in the screen buffer of the backing data for this widget and return it as a `character` type.
`(package private) character`	`getScreenValue(boolean initialized, BaseDataType bdt, java.lang.String fmt, boolean ignoreFormat)` Internal worker for getting the SCREEN-VALUE on a per-widget basis.
`handle`	`getSideLabelHandle()` Obtains the text widget that is used as the side label for this widget.
`logical`	`getStretchToFit()` Gets STRETCH-TO-FIT attribute.
`character`	`getTable()` Queries the TABLE attribute of this widget.
`integer`	`getTabPosition()` Returns the current readable TAB-POSITION widget's attribute within its field-group.
`character`	`getTitle()` Blocks attempts to access this attribute.
`integer`	`getTitleFont()` Get the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.
`character`	`getTooltip()` Queries the TOOLTIP attribute of this widget.
`logical`	`getTransparent()` Gets TRANSPARENT attribute.
`(package private) ValidationExpr`	`getValidationExpression()` Get validation expression associated with this widget.
`(package private) ValidationMsg`	`getValidationMessage()` Get validation message associated with this widget.
`decimal`	`getVirtHeight()` Blocks attempts to access this attribute.
`integer`	`getVirtHeightPixels()` Blocks attempts to access this attribute.
`decimal`	`getVirtWidth()` Blocks attempts to access this attribute.
`integer`	`getVirtWidthPixels()` Blocks attempts to access this attribute.
`integer`	`getWidgetId()` Gets the WIDGET-ID writable attribute.
`decimal`	`getWidth()` Get the WIDTH Progress attribute.
`decimal`	`getWidthChars()` Blocks attempts to access this attribute.
`integer`	`getWidthPixels()` Queries the WIDTH-PIXELS attribute of this widget.
`handle`	`getWindow()` Gets the WINDOW attribute.
`integer`	`getX()` Blocks attempts to access this attribute.
`integer`	`getY()` Blocks attempts to access this attribute.
`ZOrderClass`	`getZOrderClass()` Get the Z-Order class of this widget.
`boolean`	`hasFormat()` Checks if the given widget has valid format string or even has the format attribute.
`protected boolean`	`hasNameReadOnly()` Check if this resource supports the NAME attribute in read-only mode.
`protected boolean`	`hasParent(HandleChain parent)` Check if this resource has as parent the specified resource.
`void`	`hide()` Hides this widget.
`void`	`hide(boolean noPause)` Hides this widget.
`protected boolean`	`implicitDeletion()` Check if the resource may be implicitly deleted.
`BaseDataType`	`inputValue()` Reads the INPUT-VALUE attribute (value of the widget currently in the screen-buffer).
`logical`	`isAutoCompletion()` Get AUTO-COMPLETION attribute value.
`logical`	`isAutoResize()` Get AUTO-RESIZE attribute value.
`logical`	`isAutoReturn()` Get value of the AUTO-RETURN attribute.
`protected boolean`	`isChained()` Check if this resource can be reported as chained.
`logical`	`isChecked()` Gets the CHECKED writable attribute.
`logical`	`isDisableRedraw()` Gets the DISABLE-REDRAW attribute.
`logical`	`isEntered()` Checks whether the widget was changed during the most recent editing operation.
`protected boolean`	`isExpandLabel()` Returns state of label expansion.
`logical`	`isFocusedRowSelected()` Checks whether the row that has the focus is selected.
`logical`	`isHidden()` Gets the HIDDEN writable attribute.
`logical`	`isKeepFrameZOrder()` Blocks attempts to access this attribute.
`logical`	`isManualHighlight()` Get value of the MANUAL-HIGHLIGHT attribute.
`logical`	`isModified()` Queries if the SCREEN-VALUE attribute for this widget was changed.
`logical`	`isMovable()` Queries if the user is allowed to move this widget using direct manipulation.
`logical`	`isMultiple()` Blocks attempts to access this attribute.
`logical`	`isNotEntered()` Checks whether the widget was NOT changed during the most recent editing operation.
`logical`	`isReadOnly()` Checks whether the widget is write-protected.
`logical`	`isResizable()` Getter for RESIZABLE attribute.
`logical`	`isScrollable()` Blocks attempts to access this attribute.
`logical`	`isSelectable()` Get the SELECTABLE writable attribute.
`logical`	`isSelected()` Blocks attempts to access this attribute.
`logical`	`isSelected(character item)` Blocks attempts to access this widget method.
`logical`	`isSelected(int64 index)` Blocks attempts to access this widget method.
`logical`	`isSensitive()` Queries the SENSITIVE attribute of this widget.
`logical`	`isTabStop()` Get value of the TAB-STOP attribute.
`boolean`	`isTabWidget()` Tests if this widget can be a tab item of its field-group widget.
`logical`	`isTextSelected()` Blocks attempts to access this attribute.
`logical`	`isThreeD()` Blocks attempts to access this attribute.
`boolean`	`isValidatable()` Checks if the widget has a validation expression registered.
`logical`	`isVisible()` Get the VISIBLE writable attribute.
`protected java.lang.String`	`labelSizeCheck(java.lang.String label)` Check it the requested new label size is OK for given widget.
`logical`	`loadImage(character name)` Load widget(button or image) image from specified file name.
`logical`	`loadImage(character name, int64 xOffset)` Load widget(button or image) image from specified file name.
`logical`	`loadImage(character name, int64 xOffset, int64 yOffset)` Load widget(button or image) image from specified file name.
`logical`	`loadImage(character name, int64 xOffset, int64 yOffset, int64 width)` Load widget(button or image) image from specified file name.
`logical`	`loadImage(character name, int64 xOffset, int64 yOffset, int64 width, int64 height)` Load widget(button or image) image from specified file name.
`boolean`	`loadImage(java.lang.String name)` Load widget(button or image) image from specified file name.
`boolean`	`loadImage(java.lang.String name, long xOffset)` Load widget(button or image) image from specified file name.
`boolean`	`loadImage(java.lang.String name, long xOffset, long yOffset)` Load widget(button or image) image from specified file name.
`boolean`	`loadImage(java.lang.String name, long xOffset, long yOffset, long width)` Load widget(button or image) image from specified file name.
`boolean`	`loadImage(java.lang.String name, long xOffset, long yOffset, long width, long height)` Load widget(button or image) image from specified file name.
`logical`	`loadMousePointer(character pointerName)` The implementation of LOAD-MOUSE-POINTER() method.
`logical`	`loadMousePointer(java.lang.String pointerName)` The implementation of LOAD-MOUSE-POINTER() method.
`logical`	`moveAfterTabItem(CommonWidget widget)` This method implements MOVE-AFTER-TAB function.
`logical`	`moveAfterTabItem(handle widget)` This method implements MOVE-AFTER-TAB function.
`logical`	`moveBeforeTabItem(CommonWidget widget)` Assigns the current widget to the tab position before the specified in the same field group.
`logical`	`moveBeforeTabItem(handle widget)` Assigns the current widget to the tab position before the specified in the same field group.
`logical`	`moveToBottom()` This method implements MOVE-TO-BOTTOM function.
`logical`	`moveToTop()` This method implements MOVE-TO-TOP function.
`protected boolean`	`moveToWorker(boolean top)` Worker for the `moveToTop()` and `moveToBottom()` code.
`character`	`name()` Gets the widget name.
`protected void`	`notQueryable(java.lang.String attr)` Report that the attribute is not queryable
`protected void`	`notQueryable(java.lang.String attr, boolean showError)` Report that the attribute is not queryable
`protected void`	`notSettable(java.lang.String attr)` Report that the attribute is not settable
`protected void`	`notSettable(java.lang.String attr, boolean showError)` Report that the attribute is not settable
`protected void`	`notWorker(boolean qry, java.lang.String attr, boolean showError)` Report that the attribute is not queryable or settable.
`void`	`openPopup()` Opens the popup menu set on the widget.
`boolean`	`preRealizeCheck()` Reports if this widget object is valid to realize.
`protected int`	`processSideLabel(boolean explicit)` Process the widget's side-label (if it can have one).
`protected void`	`pushScreenDefinition()` Conditionally call `GenericFrame.pushScreenDefinition()`, depending if the frame was set or not for this widget.
`void`	`pushWidgetAttr(java.lang.String[] fnames, java.lang.Object[] values)` Push the specified widget attribute changes to the client-side.
`void`	`pushWidgetAttr(java.lang.String fname, java.lang.Object value)` Push the specified widget attribute change to the client-side.
`void`	`readOnlyError(java.lang.String attribute)` Deprecated.
`void`	`readOnlyError(java.lang.String attribute, java.lang.Object expr)` Shows a specific error, as this read-only `attribute` was used on the right-side of an assignment.
`void`	`realize()` Stub implementation of the 'realize' method.
`logical`	`refresh()` Blocks attempts to access this widget method.
`protected boolean`	`resourceDelete()` Delete the resource.
`(package private) boolean`	`restoreSharedState()` Restore the shared state for this widget: HELP and VALEXP.
`(package private) void`	`saveSharedState()` Save the shared state for this widget: HELP and VALEXP.
`logical`	`selectAll()` Blocks attempts to access this widget method.
`logical`	`selectFocusedRow()` Blocks attempts to access this widget method.
`void`	`setAtFormatLength(int length)` Set the length of the format for the widget's @ phrases.
`void`	`setAttr(java.lang.String fname, boolean currentValue, boolean newValue, BooleanConsumer setter)` Sets config field value.
`void`	`setAttr(java.lang.String fname, byte currentValue, byte newValue, ByteConsumer setter)` Sets config field value.
`void`	`setAttr(java.lang.String fname, char currentValue, char newValue, CharConsumer setter)` Sets config field value.
`void`	`setAttr(java.lang.String fname, double currentValue, double newValue, java.util.function.DoubleConsumer setter)` Sets config field value.
`void`	`setAttr(java.lang.String fname, int currentValue, int newValue, java.util.function.IntConsumer setter)` Sets config field value.
`void`	`setAttr(java.lang.String fname, long currentValue, long newValue, java.util.function.LongConsumer setter)` Sets config field value.
`void`	`setAttr(java.lang.String fname, short currentValue, short newValue, ShortConsumer setter)` Sets config field value.
`<T> void`	`setAttr(java.lang.String fname, T currentValue, T newValue, java.util.function.Consumer<T> setter)` Sets config field value.
`<T> void`	`setAttr(java.lang.String fname, T currentValue, T newValue, java.util.function.Consumer<T> setter, boolean force)` Sets config field value.
`<T> void`	`setAttrs(java.lang.String[] fnames, T[] currentValues, T[] newValues, java.util.function.Consumer<T> setter)` Sets config field value.
`void`	`setAutoCompletion(boolean autoCompletion)` Set AUTO-COMPLETION attribute value.
`void`	`setAutoCompletion(logical autoCompletion)` Set AUTO-COMPLETION attribute value.
`void`	`setAutoResize(boolean autoResize)` Set AUTO-RESIZE attribute value.
`void`	`setAutoResize(logical autoResize)` Set AUTO-RESIZE attribute value.
`void`	`setAutoReturn(boolean autoReturn)` Sets the AUTO-RETURN option.
`void`	`setAutoReturn(logical autoReturn)` Sets the AUTO-RETURN option.
`void`	`setBgColor(NumberType bgcolor)` Blocks attempts to access this attribute.
`void`	`setBgColorRgb(NumberType bgcolorRgb)` Blocks attempts to access this attribute.
`void`	`setBlank(boolean blank)` Sets the BLANK option.
`void`	`setChecked(boolean checked)` Sets the CHECKED writable attribute.
`void`	`setChecked(logical checked)` Sets the CHECKED writable attribute.
`void`	`setColumn(double column)` Blocks attempts to access this attribute.
`void`	`setColumn(NumberType column)` Blocks attempts to access this attribute.
`void`	`setColumnFont(int64 fontNum)` Set the COLUMN-FONT attribute of this browse column widget.
`void`	`setColumnFont(long fontNum)` Set the COLUMN-FONT attribute of this browse column widget.
`void`	`setColumnLabel(character columnLabel)` Setter of COLUMN-LABEL attribute.
`void`	`setColumnLabel(java.lang.String columnLabel)` Setter of COLUMN-LABEL attribute.
`void`	`setContextHelpId(int id)` Sets the WIDGET-ID writable attribute.
`void`	`setContextHelpId(integer id)` Sets the CONTEXT-HELP-ID writable attribute.
`void`	`setConvert3D(boolean flag)` Set CONVERT-3D-COLORS attribute.
`void`	`setConvert3D(logical flag)` Set CONVERT-3D-COLORS attribute.
`void`	`setCursorOffset(double offset)` Sets the index position of the cursor in a text editing widget.
`void`	`setCursorOffset(NumberType offset)` Sets the index position of the cursor in a text editing widget.
`void`	`setDataType(character dataType)` Sets new value of DATA-TYPE attribute.
`void`	`setDataType(java.lang.String dataType)` Sets new value of DATA-TYPE attribute.
`void`	`setDbname(java.lang.String dbname)` Set the value of the widget's DBNAME attribute.
`void`	`setDColor(Color displayColor)` Sets the display color.
`void`	`setDColor(NumberType param)` Sets the display color.
`void`	`setDeblank(boolean deblank)` Sets the DEBLANK option.
`void`	`setDisableAutoZap(boolean disableAutoZap)` Sets the DISABLE-AUTO-ZAP option.
`void`	`setDisableRedraw(boolean value)` Sets the DISABLE-REDRAW attribute.
`void`	`setFgColor(NumberType fgcolor)` Blocks attempts to access this attribute.
`void`	`setFgColorRgb(NumberType fgcolorRgb)` Blocks attempts to access this attribute.
`void`	`setFont(int64 fontNum)` Set the FONT attribute of this widget.
`void`	`setFont(long fontNum)` Set the FONT attribute of this widget.
`void`	`setFormat(character format)` Sets the format specification.
`void`	`setFormat(java.lang.String format)` Sets the format specification.
`void`	`setFrame(FrameWidget frame)` Sets the containing frame instance.
`void`	`setFrame(GenericFrame frame)` Sets the containing frame instance.
`void`	`setFrame(handle hFrame)` Sets the containing frame instance.
`void`	`setFrameHandle(CommonFrame frame)` Sets the FRAME attribute, containing frame instance.
`void`	`setFrameHandle(FrameWidget frame)` Sets the FRAME attribute, containing frame instance.
`void`	`setFrameHandle(handle h)` Sets the FRAME attribute, containing frame instance.
`void`	`setFromOCX(boolean fromOCX)` Marks the widget as a replacement for an OCX control.
`void`	`setGroup(Group group)` Establishes a relationship between the container and the elements in a given widget group.
`void`	`setHeader(boolean header)` Mark widget as a header.
`void`	`setHeight(NumberType heightChars)` Set the HEIGHT Progress attribute.
`void`	`setHeightChars(double h)` Blocks attempts to access this attribute.
`void`	`setHeightChars(NumberType h)` Blocks attempts to access this attribute.
`void`	`setHeightPixels(int heightPixels)` Sets new value of HEIGHT-PIXELS attribute.
`void`	`setHeightPixels(NumberType heightPixels)` Sets new value of HEIGHT-PIXELS attribute.
`void`	`setHelp(character help)` Dynamically sets the help text, by setting the attribute.
`void`	`setHelp(java.lang.String help)` Dynamically sets the help text, by setting the attribute.
`void`	`setHelpDefault(java.lang.String help)` Sets the default help text statically, when the frame is designed using value from database schema.
`void`	`setHelpStatic(java.lang.String help)` Sets the help text statically, when the frame is designed.
`void`	`setHidden(boolean hidden)` Sets the HIDDEN writable attribute.
`void`	`setHidden(logical hidden)` Sets the HIDDEN writable attribute.
`void`	`setId(int id)` Sets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).
`void`	`setKeepFrameZOrder(boolean k)` Blocks attempts to access this attribute.
`void`	`setKeepFrameZOrder(logical k)` Blocks attempts to access this attribute.
`void`	`setLabel(character label)` Sets the label text, removing any '&' characters first (this is an undocumented feature of Progress with labels).
`void`	`setLabel(I18nString label)` Sets the label text, removing any '&' characters first (this is an undocumented feature of Progress with labels).
`void`	`setLabel(java.lang.String label)` Sets the label text, removing any '&' characters first (this is an undocumented feature of Progress with labels).
`void`	`setLabelFont(int64 fontNum)` Set the LABEL-FONT attribute of this browse column widget.
`void`	`setLabelFont(long fontNum)` Set the LABEL-FONT attribute of this browse column widget.
`protected void`	`setLabelInt(java.lang.String label, java.lang.String untranslated)` Sets the label text.
`void`	`setManualHighlight(boolean value)` Set value of the MANUAL-HIGHLIGHT attribute.
`void`	`setManualHighlight(logical value)` Set value of the BLANK attribute.
`void`	`setMaxHeightChars(decimal m)` Blocks attempts to access this attribute.
`void`	`setMaxWidthChars(decimal m)` Blocks attempts to access this attribute.
`void`	`setMenuKey(character value)` Sets the MENU-KEY writable attribute.
`void`	`setMenuKey(java.lang.String value)` Sets the MENU-KEY writable attribute.
`void`	`setMenuMouse(int value)` Sets the MENU-MOUSE writable attribute.
`void`	`setMenuMouse(int64 value)` Sets the MENU-MOUSE writable attribute.
`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`	`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`	`setMultiple(boolean multiple)` Blocks attempts to access this attribute.
`void`	`setMultiple(logical multiple)` Blocks attempts to access this attribute.
`void`	`setNextTabItem(GenericWidget<?> n)` Blocks attempts to access this attribute.
`void`	`setNoAutoValidate(boolean noAutoValidate)` Sets the NO-AUTO-VALIDATE option.
`void`	`setNumSelectedRows(int64 r)` Blocks attempts to access this attribute.
`void`	`setParent(GenericWidget<?> p)` Blocks attempts to access this attribute.
`void`	`setParentHandle(CommonWidget w)` Sets the PARENT attribute to the specified widget.
`void`	`setParentHandle(handle h)` Sets the PARENT attribute to the resource specified in the given handle.
`void`	`setPfColor(Color inputColor)` Sets the input (prompt/edit mode) color.
`void`	`setPfColor(NumberType param)` Sets the input (prompt/edit mode) color.
`void`	`setPopupMenu(handle menu)` Set widget's POPUP-MENU.
`void`	`setPopupMenu(MenuWidget menu)` Set widget's POPUP-MENU.
`void`	`setQuery(P2JQuery q)` Blocks attempts to access this attribute.
`void`	`setReadOnly(logical r)` Sets the READ-ONLY attribute of the widget.
`void`	`setResizable(boolean on)` Setter for RESIZABLE attribute.
`void`	`setResizable(logical on)` Setter for RESIZABLE attribute.
`void`	`setRetainShape(boolean flag)` Set RETAIN-SHAPE attribute.
`void`	`setRetainShape(logical flag)` Set RETAIN-SHAPE attribute.
`void`	`setRow(double row)` Blocks attempts to access this attribute.
`void`	`setRow(NumberType row)` Blocks attempts to access this attribute.
`protected void`	`setScreenLock(boolean lock)` Lock or the the specified handle and any attribute assignments are cached until the `lock` is released.
`void`	`setScreenValue(character value)` Set the current value in the screen buffer of the backing data for this widget.
`(package private) boolean`	`setScreenValue(ScreenBuffer frameBuf, java.lang.Object value, boolean inUIStmt)` Internal worker for setting the SCREEN-VALUE on a per-widget basis.
`(package private) boolean`	`setScreenValue(ScreenBuffer frameBuf, java.lang.Object value, boolean inUIStmt, character unparsedValue)` Internal worker for setting the SCREEN-VALUE on a per-widget basis.
`void`	`setScreenValue(java.lang.String screenValue)` Sets the SCREEN-VALUE writable attribute.
`protected void`	`setScreenValueInt(character value)` Set the current value in the screen buffer of the backing data for this widget.
`protected void`	`setScreenValueNoErrorHandling(character value)` Set the current value in the screen buffer of the backing data for this widget.
`void`	`setScrollable(boolean s)` Blocks attempts to access this attribute.
`void`	`setScrollable(logical s)` Blocks attempts to access this attribute.
`void`	`setSelectable(boolean value)` Get the SELECTABLE writable attribute.
`void`	`setSelectable(logical value)` Set the SELECTABLE writable attribute.
`void`	`setSelected(boolean s)` Blocks attempts to access this attribute.
`void`	`setSelected(logical s)` Blocks attempts to access this attribute.
`void`	`setSensitive(boolean s)` Sets new value of SENSITIVE attribute.
`void`	`setSensitive(character s)` Sets new value of SENSITIVE attribute.
`void`	`setSensitive(logical s)` Sets new value of SENSITIVE attribute.
`void`	`setSensitive(java.lang.String s)` Sets new value of SENSITIVE attribute.
`void`	`setSideLabelHandle(handle label)` Sets the text widget that is used as the side label for this widget.
`void`	`setStretchToFit(boolean flag)` Set STRETCH-TO-FIT attribute.
`void`	`setStretchToFit(logical flag)` Set STRETCH-TO-FIT attribute.
`void`	`setTable(java.lang.String table)` Set the value of the widget's TABLE attribute.
`void`	`setTabStop(boolean value)` Set value of the TAB-STOP attribute.
`void`	`setTabStop(logical value)` Set value of the TAB-STOP attribute.
`void`	`setThreeD(boolean threeD)` Blocks attempts to access this attribute.
`void`	`setThreeD(logical threeD)` Blocks attempts to access this attribute.
`void`	`setTitle(character t)` Blocks attempts to access this attribute.
`void`	`setTitle(java.lang.String t)` Blocks attempts to access this attribute.
`void`	`setTitleFont(int64 fontNum)` Set the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.
`void`	`setTitleFont(long fontNum)` Set the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.
`void`	`setTooltip(character tooltip)` Sets new value of TOOLTIP attribute.
`void`	`setTooltip(java.lang.String tooltip)` Sets new value of TOOLTIP attribute.
`void`	`setTransparent(boolean flag)` Set TRANSPARENT attribute.
`void`	`setTransparent(logical flag)` Set TRANSPARENT attribute.
`void`	`setValidation(ValidationExpr valexp, java.lang.String valmsg)` Registers callbacks for validation processing (during editing) for any input into this widget.
`void`	`setValidation(ValidationExpr valexp, ValidationMsg valmsg)` Registers callbacks for validation processing (during editing) for any input into this widget.
`void`	`setVertical(boolean direction)` Blocks attempts to access this attribute.
`void`	`setVirtHeight(NumberType height)` Blocks attempts to access this attribute.
`void`	`setVirtHeightPixels(NumberType height)` Blocks attempts to access this attribute.
`void`	`setVirtWidth(NumberType width)` Blocks attempts to access this attribute.
`void`	`setVirtWidthPixels(NumberType width)` Blocks attempts to access this attribute.
`void`	`setVisible(boolean visible)` Set the VISIBLE writable attribute.
`void`	`setVisible(logical visible)` Set the VISIBLE writable attribute.
`void`	`setWidgetId(int id)` Sets the WIDGET-ID writable attribute.
`void`	`setWidgetId(integer id)` Sets the WIDGET-ID writable attribute.
`void`	`setWidth(NumberType widthChars)` Set the WIDTH Progress attribute.
`void`	`setWidthChars(double h)` Blocks attempts to access this attribute.
`void`	`setWidthChars(NumberType h)` Blocks attempts to access this attribute.
`void`	`setWidthPixels(int widthPixels)` Sets new value of WIDTH-PIXELS attribute.
`void`	`setWidthPixels(NumberType widthPixels)` Sets new value of WIDTH-PIXELS attribute.
`void`	`setX(int x)` Blocks attempts to access this attribute.
`void`	`setX(NumberType x)` Blocks attempts to access this attribute.
`void`	`setY(int y)` Blocks attempts to access this attribute.
`void`	`setY(NumberType y)` Blocks attempts to access this attribute.
`protected int`	`truncatePixelSize(int size, SizeAttribute attr)` In 4GL the widget size (WIDTH/HEIGHT-PIXELS) can be set larger than the maximum X/Y values.
`java.lang.String`	`type()` Get the type of this handle as type of String.
`void`	`underline()` Underlines this widget on the screen.
`void`	`underline(Stream stream)` Underlines this widget on the screen.
`boolean`	`valid()` Reports if this widget object is valid for use.
`java.lang.String`	`validate(BaseDataType val, boolean ignore)` Processes validation rules (if they exist), error checking and anyother constraint processing that needs to be applied.
`logical`	`validateFields()` Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.
`protected logical`	`validateFields(boolean enabledOnly)` Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.
`logical`	`validateFields(character val)` Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.
`logical`	`validateFields(java.lang.String val)` Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.
`protected boolean`	`validateLabelAssignment()` Implements legacy validations performed at side-label assignment.
`private java.lang.String`	`validateWorker(BaseDataType newVal)` Processes validation rules, error checking and any other user-defined constraint processing that needs to be applied.
`void`	`view()` Shows this widget.
`protected void`	`warningAlreadyRealized(java.lang.String attributeName)` Displays "Unable to set ATTRIBUTE_NAME because the widget has been realized." warning
`protected java.lang.String`	`widgetName()` Get widget name for the error message

Methods inherited from class com.goldencode.p2j.util.HandleChain
firstResource, firstResource, getHead, getNextSibling, getNextSibling, getPrevSibling, 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.CommonWidget
getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain
getNextSibling, getPrevSibling, 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
- frame
```
protected GenericFrame frame
```
  The containing frame object.
- config
```
protected T extends WidgetConfig config
```
  The configuration container.
- deleted
```
protected boolean deleted
```
  Flag indicating the resource was deleted.
- realizeOnAttributeAccess
```
protected boolean realizeOnAttributeAccess
```
  Flag indicating if the widget must be realized on attribute access.
- internalScreenValueUsage
```
protected boolean internalScreenValueUsage
```
  Flag indicating if the setScreenValue(com.goldencode.p2j.util.character) is being called from the converted code or from within FWD.
- valexp
```
private ValidationExpr valexp
```
  The validation expression to use to test proposed edits for this widget.
- valmsg
```
private ValidationMsg valmsg
```
  The expression to generate an error message when validation fails.
- saveValexp
```
private ValidationExpr saveValexp
```
  Saved value for valexp field; used for imported shared frames only.
- saveValmsg
```
private ValidationMsg saveValmsg
```
  Saved value for valmsg field; used for imported shared frames only.
- menu
```
private MenuWidget menu
```
  MenuWidget handle owned by this widget
- dynamic
```
private boolean dynamic
```
  When true, marks this resource as being dynamically created.
- frameLock
```
private boolean frameLock
```
  When set, all attribute assignments are cached on server-side and pushed to client-side only when the lock is set to false via setScreenLock(boolean). When this flag is true, any pushScreenDefinition() calls are ignored
- dbName
```
private java.lang.String dbName
```
  The value of the DBNAME attribute.
- tableName
```
private java.lang.String tableName
```
  The value of the TABLE attribute.
- pendingScreenValue
```
private character pendingScreenValue
```
  Holds the SCREEN-VALUE until the parent frame is set.
- defaultHelp
```
private java.lang.String defaultHelp
```
  Holds default (schema) help message if any is defined in database.
- isDefaultHelp
```
private boolean isDefaultHelp
```
  true if the currently displayed help is the default(overrideable) schema help.
- saveDefaultHelp
```
private java.lang.String saveDefaultHelp
```
  Saved value for defaultHelp field; used for imported shared frames only.
- saveIsDefaultHelp
```
private boolean saveIsDefaultHelp
```
  Saved value for isDefaultHelp field; used for imported shared frames only.
- saveConfigHelp
```
private java.lang.String saveConfigHelp
```
  Saved value for the widget's config help field; used for imported shared frames only.
- sharedStateSaved
```
private boolean sharedStateSaved
```
  Flag indicating if shared state was saved or not.
- logicalTerminal
```
private LogicalTerminal logicalTerminal
```
  Cached logical terminal instance
- configBatchingDisabled
```
private static boolean configBatchingDisabled
```
  When true config field changes batching is disabled.
- selectiveConfigFlushDisabled
```
private static boolean selectiveConfigFlushDisabled
```
  When true selective config flushing is disabled.
- configDef
```
private WidgetConfigDef configDef
```
  The cached config definition for the widget's config

Constructor Detail
- GenericWidget
```
public GenericWidget(boolean dynamic,
                     T config)
```
  Constructor.
  
  Parameters:
  
  dynamic - Flag indicating if this is a static or dynamic resource.
  
  config - The container for all state to be transferred to the client.
- GenericWidget
```
public GenericWidget(boolean dynamic,
                     T config,
                     GenericWidget<T> before,
                     boolean firstAsLast)
```
  Constructor.
  
  Parameters:
  
  dynamic - Flag indicating if this is a static or dynamic resource.
  
  config - 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.

Method Detail

setFrame
```
public void setFrame(handle hFrame)
```
Sets the containing frame instance.

Specified by:

setFrame in interface CommonWidget

Parameters:

hFrame - handle which is expected to contain a FrameWidget instance

setFrameHandle
```
public void setFrameHandle(handle h)
```
Sets the FRAME attribute, containing frame instance.

Specified by:

setFrameHandle in interface CommonWidget

Parameters:

h - a handle containing the GenericFrame instance that contains this widget

setFrameHandle
```
public void setFrameHandle(CommonFrame frame)
```
Sets the FRAME attribute, containing frame instance.

Specified by:

setFrameHandle in interface CommonWidget

Parameters:

frame - The frame instance that will contain this widget.

setFrameHandle
```
public void setFrameHandle(FrameWidget frame)
```
Sets the FRAME attribute, containing frame instance.

Specified by:

setFrameHandle in interface CommonWidget

Parameters:

frame - The frame instance that will contain this widget.

setFrame
```
public void setFrame(GenericFrame frame)
```
Sets the containing frame instance.

Specified by:

setFrame in interface CommonWidget

Parameters:

frame - GenericFrame instance that contains this widget

setFrame
```
public void setFrame(FrameWidget frame)
```
Sets the containing frame instance.

Specified by:

setFrame in interface CommonWidget

Parameters:

frame - GenericFrame instance that contains this widget

getFrame
```
public GenericFrame getFrame()
```
Gets the containing frame instance.

Specified by:

getFrame in interface CommonWidget

Returns:

The frame that contains this widget.

getFrameHandle
```
public handle getFrameHandle()
```
Gets the containing frame instance, as a handle.

Specified by:

getFrameHandle in interface CommonWidget

Returns:

The frame that contains this widget.

getFrameName
```
public character getFrameName()
```
Gets the frame name.

Specified by:

getFrameName in interface CommonWidget

Returns:

This widget's frame name.

getId
```
public int getId()
```
Gets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).

Specified by:

getId in interface CommonWidget

Returns:

The numeric ID of this widget.

setId
```
public void setId(int id)
```
Sets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).

Specified by:

setId in interface CommonWidget

Parameters:

id - The numeric ID of this widget.

_isEntered
```
public boolean _isEntered()
```
Checks whether the widget was changed during the most recent editing operation.

Returns:

true if this widget has changed its value.

isEntered
```
public logical isEntered()
```
Checks whether the widget was changed during the most recent editing operation.

Specified by:

isEntered in interface CommonWidget

Returns:

true if this widget has changed its value.

_isNotEntered
```
public boolean _isNotEntered()
```
Checks whether the widget was changed during the most recent editing operation.

Returns:

true if this widget has changed its value.

isNotEntered
```
public logical isNotEntered()
```
Checks whether the widget was NOT changed during the most recent editing operation.

Specified by:

isNotEntered in interface CommonWidget

Returns:

true if this widget has not changed its value.

isFocusedRowSelected
```
public logical isFocusedRowSelected()
```
Checks whether the row that has the focus is selected. This is the equivalent of the FOCUSED-ROW-SELECTED attribute of the browse widget.

Specified by:

isFocusedRowSelected in interface CommonWidget

Returns:

true if the focused row is selected.

setAutoReturn
```
public void setAutoReturn(boolean autoReturn)
```
Sets the AUTO-RETURN option.

Parameters:

autoReturn - true if the option is set to ON.

setAutoReturn
```
public void setAutoReturn(logical autoReturn)
```
Sets the AUTO-RETURN option.

Parameters:

autoReturn - true if the option is set to ON.

isAutoReturn
```
public logical isAutoReturn()
```
Get value of the AUTO-RETURN attribute.

Returns:

value of the attribute.

setAutoResize
```
public void setAutoResize(logical autoResize)
```
Set AUTO-RESIZE attribute value.

Specified by:

setAutoResize in interface CommonWidget

Parameters:

autoResize - New value for the attribute.

setAutoResize
```
public void setAutoResize(boolean autoResize)
```
Set AUTO-RESIZE attribute value.

Specified by:

setAutoResize in interface CommonWidget

Parameters:

autoResize - New value for the attribute.

setAutoCompletion
```
public void setAutoCompletion(logical autoCompletion)
```
Set AUTO-COMPLETION attribute value.

Specified by:

setAutoCompletion in interface CommonWidget

Parameters:

autoCompletion - New value for the attribute.

setAutoCompletion
```
public void setAutoCompletion(boolean autoCompletion)
```
Set AUTO-COMPLETION attribute value.

Specified by:

setAutoCompletion in interface CommonWidget

Parameters:

autoCompletion - New value for the attribute.

isAutoCompletion
```
public logical isAutoCompletion()
```
Get AUTO-COMPLETION attribute value.

Specified by:

isAutoCompletion in interface CommonWidget

Returns:

The value of the attribute.

isAutoResize
```
public logical isAutoResize()
```
Get AUTO-RESIZE attribute value.

Specified by:

isAutoResize in interface CommonWidget

Returns:

The value of the attribute.

setBlank
```
public void setBlank(boolean blank)
```
Sets the BLANK option.

Specified by:

setBlank in interface CommonWidget

Parameters:

blank - true if the option is set to ON.

getColumn
```
public decimal getColumn()
```
Blocks attempts to access this attribute.

Specified by:

getColumn in interface Coordinates

Returns:

nothing.

getFrameColumn
```
public decimal getFrameColumn()
```
Blocks attempts to access this attribute.

Specified by:

getFrameColumn in interface CommonWidget

Returns:

nothing.

setColumn
```
public void setColumn(NumberType column)
```
Blocks attempts to access this attribute.

Specified by:

setColumn in interface Coordinates

Parameters:

column - Not used.

getColumnLabel
```
public character getColumnLabel()
```
Getter of COLUMN-LABEL attribute.

Specified by:

getColumnLabel in interface CommonField

Returns:

current value of COLUMN-LABEL attribute.

setColumnLabel
```
public void setColumnLabel(character columnLabel)
```
Setter of COLUMN-LABEL attribute.

Specified by:

setColumnLabel in interface CommonField

Parameters:

columnLabel - New value of a attribute.

setColumnLabel
```
public void setColumnLabel(java.lang.String columnLabel)
```
Setter of COLUMN-LABEL attribute.

Specified by:

setColumnLabel in interface CommonField

Parameters:

columnLabel - New value of a attribute.

setColumn
```
public void setColumn(double column)
```
Blocks attempts to access this attribute.

Specified by:

setColumn in interface Coordinates

Parameters:

column - Not used.

getCursorOffset
```
public integer getCursorOffset()
```
Obtains the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in BROWSE columns (only when the cell is FILL-IN or COMBO-BOX), COMBO-BOX, EDITOR or FILL-IN widgets.

Specified by:

getCursorOffset in interface CommonWidget

Returns:

The character index at which the cursor is placed.

setCursorOffset
```
public void setCursorOffset(double offset)
```
Sets the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in BROWSE columns (only when the cell is FILL-IN or COMBO-BOX), COMBO-BOX, EDITOR or FILL-IN widgets.

Specified by:

setCursorOffset in interface CommonWidget

Parameters:

offset - The character index at which the cursor is to be placed.

setCursorOffset
```
public void setCursorOffset(NumberType offset)
```
Sets the index position of the cursor in a text editing widget. This corresponds to the CURSOR-OFFSET attribute in BROWSE columns (only when the cell is FILL-IN or COMBO-BOX), COMBO-BOX, EDITOR or FILL-IN widgets.

Specified by:

setCursorOffset in interface CommonWidget

Parameters:

offset - The character index at which the cursor is to be placed.

getDColor
```
public integer getDColor()
```
Blocks attempts to access this attribute.

Specified by:

getDColor in interface CommonWidget

Returns:

nothing.

setDColor
```
public void setDColor(NumberType param)
```
Sets the display color.

Specified by:

setDColor in interface CommonWidget

Parameters:

param - The display color.

setDColor
```
public void setDColor(Color displayColor)
```
Sets the display color.

Specified by:

setDColor in interface CommonWidget

Parameters:

displayColor - The display color.

setDeblank
```
public void setDeblank(boolean deblank)
```
Sets the DEBLANK option.

Specified by:

setDeblank in interface CommonWidget

Parameters:

deblank - true if the option is set to ON.

setDisableAutoZap
```
public void setDisableAutoZap(boolean disableAutoZap)
```
Sets the DISABLE-AUTO-ZAP option.

Specified by:

setDisableAutoZap in interface CommonWidget

Parameters:

disableAutoZap - true if the option is set to ON.

setFormat
```
public void setFormat(character format)
```
Sets the format specification.

Specified by:

setFormat in interface CommonField

Parameters:

format - format specification

setFormat
```
public void setFormat(java.lang.String format)
```
Sets the format specification.

Specified by:

setFormat in interface CommonWidget

Specified by:

setFormat in interface CommonField

Parameters:

format - The format specification.

hasFormat
```
public boolean hasFormat()
```
Checks if the given widget has valid format string or even has the format attribute.

Returns:

TRUE if format exists, FALSE otherwise.

_getFormat
```
public java.lang.String _getFormat()
```
Gets the format specification.

Returns:

The format specification.

getFormat
```
public character getFormat()
```
Gets the format specification.

Specified by:

getFormat in interface CommonField

Returns:

The format specification.

getImage
```
public character getImage()
```
Blocks attempts to access this attribute.

Specified by:

getImage in interface CommonWidget

Returns:

nothing.

getHeightChars
```
public decimal getHeightChars()
```
Blocks attempts to access this attribute.

Specified by:

getHeightChars in interface Sizeable

Returns:

nothing.

setHeightChars
```
public void setHeightChars(NumberType h)
```
Blocks attempts to access this attribute.

Specified by:

setHeightChars in interface Sizeable

Parameters:

h - Not used.

setHeightChars
```
public void setHeightChars(double h)
```
Blocks attempts to access this attribute.

Specified by:

setHeightChars in interface Sizeable

Parameters:

h - Not used.

getWidthChars
```
public decimal getWidthChars()
```
Blocks attempts to access this attribute.

Specified by:

getWidthChars in interface Sizeable

Returns:

nothing.

getWidth
```
public decimal getWidth()
```
Get the WIDTH Progress attribute. The value is equal to the current component char width. This attribute is an alias for WIDTH-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-QUERY(widget, "WIDTH") works properly.

Specified by:

getWidth in interface Sizeable

Returns:

The integer value of the WIDTH attribute.

setWidthChars
```
public void setWidthChars(NumberType h)
```
Blocks attempts to access this attribute.

Specified by:

setWidthChars in interface Sizeable

Parameters:

h - Not used.

setWidthChars
```
public void setWidthChars(double h)
```
Blocks attempts to access this attribute.

Specified by:

setWidthChars in interface Sizeable

Parameters:

h - Not used.

setWidth
```
public void setWidth(NumberType widthChars)
```
Set the WIDTH Progress attribute. This attribute is an alias for WIDTH-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-SET(widget, "WIDTH") works properly.

Specified by:

setWidth in interface Sizeable

Parameters:

widthChars - The integer value for the new WIDTH value.

getHeight
```
public decimal getHeight()
```
Get the HEIGHT Progress attribute. The value is equal to the current component char height. This attribute is an alias for HEIGHT-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-QUERY(widget, "HEIGHT") works properly.

Specified by:

getHeight in interface Sizeable

Returns:

The integer value of the HEIGHT attribute.

setHeight
```
public void setHeight(NumberType heightChars)
```
Set the HEIGHT Progress attribute. This attribute is an alias for HEIGHT-CHARS attribute, this method shall never be called directly, its solely purpose is to assert the call CAN-SET(widget, "HEIGHT") works properly.

Specified by:

setHeight in interface Sizeable

Parameters:

heightChars - The integer value for the new HEIGHT value.

getHelp
```
public character getHelp()
```
Get the HELP writable attribute. It it was not set, the default value is returned.

Specified by:

getHelp in interface CommonField

Returns:

current value of HELP attribute

setHelp
```
public void setHelp(character help)
```
Dynamically sets the help text, by setting the attribute.

Specified by:

setHelp in interface CommonField

Parameters:

help - The new help text.

setHelp
```
public void setHelp(java.lang.String help)
```
Dynamically sets the help text, by setting the attribute.

Specified by:

setHelp in interface CommonField

Parameters:

help - The new help text.

setHelpStatic
```
public void setHelpStatic(java.lang.String help)
```
Sets the help text statically, when the frame is designed. For SHARED FRAMES, this attribute cannot be overwritten once it was set.

Parameters:

help - The help text.

setHelpDefault
```
public void setHelpDefault(java.lang.String help)
```
Sets the default help text statically, when the frame is designed using value from database schema.

Parameters:

help - The default help text.

isHidden
```
public logical isHidden()
```
Gets the HIDDEN writable attribute.

Specified by:

isHidden in interface CommonWidget

Returns:

The current value of the HIDDEN attribute.

_isHidden
```
public boolean _isHidden()
```
Gets the HIDDEN writable attribute.

Returns:

The current value of the HIDDEN attribute.

setHidden
```
public void setHidden(logical hidden)
```
Sets the HIDDEN writable attribute.

Specified by:

setHidden in interface CommonWidget

Parameters:

hidden - The new value for the HIDDEN attribute.

setHidden
```
public void setHidden(boolean hidden)
```
Sets the HIDDEN writable attribute.

Specified by:

setHidden in interface CommonWidget

Parameters:

hidden - The new value for the HIDDEN attribute.

isKeepFrameZOrder
```
public logical isKeepFrameZOrder()
```
Blocks attempts to access this attribute.

Specified by:

isKeepFrameZOrder in interface CommonWidget

Returns:

nothing.

setKeepFrameZOrder
```
public void setKeepFrameZOrder(logical k)
```
Blocks attempts to access this attribute.

Specified by:

setKeepFrameZOrder in interface CommonWidget

Parameters:

k - Not used.

setKeepFrameZOrder
```
public void setKeepFrameZOrder(boolean k)
```
Blocks attempts to access this attribute.

Specified by:

setKeepFrameZOrder in interface CommonWidget

Parameters:

k - Not used.

getLabel
```
public character getLabel()
```
Get the label text for this widget.

Specified by:

getLabel in interface CommonField

Returns:

The label text.

getLabelStr
```
public java.lang.String getLabelStr()
```
Get the label text for this widget.

Specified by:

getLabelStr in interface CommonWidget

Returns:

The label text.

setLabel
```
public void setLabel(character label)
```
Sets the label text, removing any '&' characters first (this is an undocumented feature of Progress with labels).

Specified by:

setLabel in interface CommonField

Parameters:

label - The new label text.

setLabel
```
public void setLabel(java.lang.String label)
```
Sets the label text, removing any '&' characters first (this is an undocumented feature of Progress with labels).

Specified by:

setLabel in interface CommonField

Parameters:

label - The new label text.

setLabel
```
public void setLabel(I18nString label)
```
Sets the label text, removing any '&' characters first (this is an undocumented feature of Progress with labels).

Specified by:

setLabel in interface CommonField

Parameters:

label - The new label text.

getMaxHeightChars
```
public decimal getMaxHeightChars()
```
Blocks attempts to access this attribute.

Specified by:

getMaxHeightChars in interface CommonWidget

Returns:

nothing.

setMaxHeightChars
```
public void setMaxHeightChars(decimal m)
```
Blocks attempts to access this attribute.

Specified by:

setMaxHeightChars in interface CommonWidget

Parameters:

m - Not used.

getMaxWidthChars
```
public decimal getMaxWidthChars()
```
Blocks attempts to access this attribute.

Specified by:

getMaxWidthChars in interface CommonWidget

Returns:

nothing.

setMaxWidthChars
```
public void setMaxWidthChars(decimal m)
```
Blocks attempts to access this attribute.

Specified by:

setMaxWidthChars in interface CommonWidget

Parameters:

m - Not used.

isModified
```
public logical isModified()
```
Queries if the SCREEN-VALUE attribute for this widget was changed.

Specified by:

isModified in interface CommonWidget

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

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

Parameters:

modified - true to mark the screen value as changed.

isMovable
```
public logical isMovable()
```
Queries if the user is allowed to move this widget using direct manipulation.

Specified by:

isMovable in interface CommonWidget

Returns:

If true, the widget is movable via direct manipulation.

setMovable
```
public void setMovable(boolean movable)
```
Defines if the user is allowed to move this widget using direct manipulation.

Specified by:

setMovable in interface CommonWidget

Parameters:

movable - true to enable movable direct manipulation.

setMovable
```
public void setMovable(logical movable)
```
Defines if the user is allowed to move this widget using direct manipulation.

Specified by:

setMovable in interface CommonWidget

Parameters:

movable - true to enable movable direct manipulation.

isMultiple
```
public logical isMultiple()
```
Blocks attempts to access this attribute.

Specified by:

isMultiple in interface CommonWidget

Returns:

nothing.

setMultiple
```
public void setMultiple(boolean multiple)
```
Blocks attempts to access this attribute.

Specified by:

setMultiple in interface CommonWidget

Parameters:

multiple - Not used.

setMultiple
```
public void setMultiple(logical multiple)
```
Blocks attempts to access this attribute.

Specified by:

setMultiple in interface CommonWidget

Parameters:

multiple - Not used.

getNextTabItem
```
public handle getNextTabItem()
```
Calculates the next widget in the tab order. Returns its NEXT-TAB-ITEM attribute value.

Specified by:

getNextTabItem in interface CommonWidget

Returns:

The next widget handle or unknown if this widget is the last.

setNextTabItem
```
public void setNextTabItem(GenericWidget<?> n)
```
Blocks attempts to access this attribute.

Specified by:

setNextTabItem in interface CommonWidget

Parameters:

n - Not used.

getPreviousTabItem
```
public handle getPreviousTabItem()
```
Calculates the previous widget in the tab order. Returns its PREV-TAB-ITEM attribute value.

Specified by:

getPreviousTabItem in interface CommonWidget

Returns:

The previous widget handle or unknown if this widget is the last.

getNumSelectedRows
```
public integer getNumSelectedRows()
```
Blocks attempts to access this attribute.

Specified by:

getNumSelectedRows in interface CommonWidget

Returns:

nothing.

setNumSelectedRows
```
public void setNumSelectedRows(int64 r)
```
Blocks attempts to access this attribute.

Specified by:

setNumSelectedRows in interface CommonWidget

Parameters:

r - Not used.

getParent
```
public CommonWidget getParent()
```
Blocks attempts to access this attribute.

Specified by:

getParent in interface CommonWidget

Returns:

nothing.

getParentHandle
```
public handle getParentHandle()
```
Gets the PARENT attribute, as a handle.

Specified by:

getParentHandle in interface CommonWidget

Returns:

the PARENT attribute.

setParentHandle
```
public void setParentHandle(handle h)
```
Sets the PARENT attribute to the resource specified in the given handle.

Specified by:

setParentHandle in interface CommonWidget

Parameters:

h - The handle with the parent resource.

setParentHandle
```
public void setParentHandle(CommonWidget w)
```
Sets the PARENT attribute to the specified widget.

Specified by:

setParentHandle in interface CommonWidget

Parameters:

w - The parent widget

setGroup
```
public void setGroup(Group group)
```
Establishes a relationship between the container and the elements in a given widget group.

Specified by:

setGroup in interface CommonWidget

Parameters:

group - The container of the widget.

getPfColor
```
public integer getPfColor()
```
Blocks attempts to access this attribute.

Specified by:

getPfColor in interface CommonWidget

Returns:

nothing.

setPfColor
```
public void setPfColor(NumberType param)
```
Sets the input (prompt/edit mode) color.

Specified by:

setPfColor in interface CommonWidget

Parameters:

param - The color to use.

setPfColor
```
public void setPfColor(Color inputColor)
```
Sets the input (prompt/edit mode) color.

Specified by:

setPfColor in interface CommonWidget

Parameters:

inputColor - The color to use for when in "input" mode.

getQuery
```
public P2JQuery getQuery()
```
Blocks attempts to access this attribute.

Specified by:

getQuery in interface CommonWidget

Returns:

nothing.

setQuery
```
public void setQuery(P2JQuery q)
```
Blocks attempts to access this attribute.

Specified by:

setQuery in interface CommonWidget

Parameters:

q - Not used.

getRow
```
public decimal getRow()
```
Blocks attempts to access this attribute.

Specified by:

getRow in interface Coordinates

Returns:

nothing.

setRow
```
public void setRow(NumberType row)
```
Blocks attempts to access this attribute.

Specified by:

setRow in interface Coordinates

Parameters:

row - Not used.

setRow
```
public void setRow(double row)
```
Blocks attempts to access this attribute.

Specified by:

setRow in interface Coordinates

Parameters:

row - Not used.

getSideLabelHandle
```
public handle getSideLabelHandle()
```
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.

Specified by:

getSideLabelHandle in interface CommonWidget

Returns:

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

setSideLabelHandle
```
public void setSideLabelHandle(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.

Specified by:

setSideLabelHandle in interface CommonWidget

Parameters:

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

isScrollable
```
public logical isScrollable()
```
Blocks attempts to access this attribute.

Specified by:

isScrollable in interface CommonWidget

Returns:

nothing.

setScrollable
```
public void setScrollable(logical s)
```
Blocks attempts to access this attribute.

Specified by:

setScrollable in interface CommonWidget

Parameters:

s - Not used.

setScrollable
```
public void setScrollable(boolean s)
```
Blocks attempts to access this attribute.

Specified by:

setScrollable in interface CommonWidget

Parameters:

s - Not used.

isSelected
```
public logical isSelected()
```
Blocks attempts to access this attribute.

Specified by:

isSelected in interface CommonWidget

Returns:

nothing.

isTextSelected
```
public logical isTextSelected()
```
Blocks attempts to access this attribute.

Returns:

nothing.

setSelected
```
public void setSelected(logical s)
```
Blocks attempts to access this attribute.

Specified by:

setSelected in interface CommonWidget

Parameters:

s - Not used.

setSelected
```
public void setSelected(boolean s)
```
Blocks attempts to access this attribute.

Specified by:

setSelected in interface CommonWidget

Parameters:

s - Not used.

isSensitive
```
public logical isSensitive()
```
Queries the SENSITIVE attribute of this widget.

Specified by:

isSensitive in interface Sensitive

Returns:

true if SENSITIVE is set.

setSensitive
```
public void setSensitive(logical s)
```
Sets new value of SENSITIVE attribute.

Specified by:

setSensitive in interface CommonWidget

Specified by:

setSensitive in interface Sensitive

Parameters:

s - new value of SENSITIVE attribute

setSensitive
```
public void setSensitive(java.lang.String s)
```
Sets new value of SENSITIVE attribute.

Specified by:

setSensitive in interface Sensitive

Parameters:

s - new value of SENSITIVE attribute

setSensitive
```
public void setSensitive(character s)
```
Sets new value of SENSITIVE attribute.

Specified by:

setSensitive in interface Sensitive

Parameters:

s - new value of SENSITIVE attribute

setSensitive
```
public void setSensitive(boolean s)
```
Sets new value of SENSITIVE attribute.

Specified by:

setSensitive in interface Sensitive

Parameters:

s - new value of SENSITIVE attribute

getDataType
```
public character getDataType()
```
Queries the DATA-TYPE attribute of this widget.

Specified by:

getDataType in interface CommonField

Returns:

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

setDataType
```
public void setDataType(character dataType)
```
Sets new value of DATA-TYPE attribute.

Specified by:

setDataType in interface CommonField

Parameters:

dataType - new value of DATA-TYPE attribute

setDataType
```
public void setDataType(java.lang.String dataType)
```
Sets new value of DATA-TYPE attribute.

Specified by:

setDataType in interface CommonField

Parameters:

dataType - new value of DATA-TYPE attribute

getTable
```
public character getTable()
```
Queries the TABLE attribute of this widget.

Specified by:

getTable in interface DatabaseInfo

Returns:

The name of the database table containing the field associated with the widget.

_getTable
```
public java.lang.String _getTable()
```
Returns the state of the TABLE attribute in non-wrapped form.

Returns:

Current value of the TABLE attribute or empty string if no value is set.

getDbName
```
public character getDbName()
```
Returns the state of the DBNAME attribute.

Specified by:

getDbName in interface DatabaseInfo

Returns:

Current value of the DBNAME attribute.

_getDbName
```
public java.lang.String _getDbName()
```
Returns the state of the DBNAME attribute in non-wrapped form.

Returns:

Current value of the DBNAME attribute or empty string if no value is set.

setTable
```
public void setTable(java.lang.String table)
```
Set the value of the widget's TABLE attribute.

Parameters:

table - The table name (not the buffer name).

setDbname
```
public void setDbname(java.lang.String dbname)
```
Set the value of the widget's DBNAME attribute.

Parameters:

dbname - The database name.

getTooltip
```
public character getTooltip()
```
Queries the TOOLTIP attribute of this widget.

Specified by:

getTooltip in interface CommonWidget

Returns:

A help text message for a text field or text variable.

setTooltip
```
public void setTooltip(character tooltip)
```
Sets new value of TOOLTIP attribute.

Specified by:

setTooltip in interface CommonWidget

Parameters:

tooltip - new value of TOOLTIP attribute

setTooltip
```
public void setTooltip(java.lang.String tooltip)
```
Sets new value of TOOLTIP attribute.

Specified by:

setTooltip in interface CommonWidget

Parameters:

tooltip - new value of TOOLTIP attribute

getWidthPixels
```
public integer getWidthPixels()
```
Queries the WIDTH-PIXELS attribute of this widget.

Specified by:

getWidthPixels in interface Sizeable

Returns:

The width of the widget in pixels.

setWidthPixels
```
public void setWidthPixels(NumberType widthPixels)
```
Sets new value of WIDTH-PIXELS attribute.

Specified by:

setWidthPixels in interface Sizeable

Parameters:

widthPixels - new value of WIDTH-PIXELS attribute

setWidthPixels
```
public void setWidthPixels(int widthPixels)
```
Sets new value of WIDTH-PIXELS attribute.

Specified by:

setWidthPixels in interface Sizeable

Parameters:

widthPixels - new value of WIDTH-PIXELS attribute

setAtFormatLength
```
public void setAtFormatLength(int length)
```
Set the length of the format for the widget's @ phrases.

Specified by:

setAtFormatLength in interface CommonWidget

Parameters:

length - The maximum format length from the widget's @ phrases.

getHeightPixels
```
public integer getHeightPixels()
```
Queries the HEIGHT-PIXELS attribute of this widget.

Specified by:

getHeightPixels in interface Sizeable

Returns:

The height of the widget in pixels.

setHeightPixels
```
public void setHeightPixels(NumberType heightPixels)
```
Sets new value of HEIGHT-PIXELS attribute.

Specified by:

setHeightPixels in interface Sizeable

Parameters:

heightPixels - new value of HEIGHT-PIXELS attribute

setHeightPixels
```
public void setHeightPixels(int heightPixels)
```
Sets new value of HEIGHT-PIXELS attribute.

Specified by:

setHeightPixels in interface Sizeable

Parameters:

heightPixels - new value of HEIGHT-PIXELS attribute

getTitle
```
public character getTitle()
```
Blocks attempts to access this attribute.

Specified by:

getTitle in interface CommonWidget

Returns:

nothing.

setTitle
```
public void setTitle(character t)
```
Blocks attempts to access this attribute.

Specified by:

setTitle in interface CommonWidget

Parameters:

t - Not used.

setTitle
```
public void setTitle(java.lang.String t)
```
Blocks attempts to access this attribute.

Specified by:

setTitle in interface CommonWidget

Parameters:

t - Not used.

setValidation
```
public void setValidation(ValidationExpr valexp,
                          ValidationMsg valmsg)
```
Registers callbacks for validation processing (during editing) for any input into this widget.

Specified by:

setValidation in interface CommonWidget

Parameters:

valexp - The Function to call to determine if the edits are allowed.

valmsg - The Function used to generate the error message on a validation failure.

setValidation
```
public void setValidation(ValidationExpr valexp,
                          java.lang.String valmsg)
```
Registers callbacks for validation processing (during editing) for any input into this widget. Use this version of the method when the message can be determined in advance.

Specified by:

setValidation in interface CommonWidget

Parameters:

valexp - The Function to call to determine if the edits are allowed.

valmsg - The error message on a validation failure.

isValidatable
```
public boolean isValidatable()
```
Checks if the widget has a validation expression registered.

Specified by:

isValidatable in interface CommonWidget

Returns:

true if the widget will have a validation expression executed during editing.

setVertical
```
public void setVertical(boolean direction)
```
Blocks attempts to access this attribute.

Specified by:

setVertical in interface CommonWidget

Parameters:

direction - Not used.

isVisible
```
public logical isVisible()
```
Get the VISIBLE writable attribute.

Specified by:

isVisible in interface HasVisible

Returns:

The current value of VISIBLE attribute.

_isVisible
```
public boolean _isVisible()
```
Get the VISIBLE writable attribute.

Returns:

The current value of VISIBLE attribute.

setVisible
```
public void setVisible(logical visible)
```
Set the VISIBLE writable attribute.

Specified by:

setVisible in interface HasVisible

Parameters:

visible - The new value for the VISIBLE attribute.

setVisible
```
public void setVisible(boolean visible)
```
Set the VISIBLE writable attribute.

Specified by:

setVisible in interface HasVisible

Parameters:

visible - The new value for the VISIBLE attribute.

isSelectable
```
public logical isSelectable()
```
Get the SELECTABLE writable attribute.

Specified by:

isSelectable in interface CommonWidget

Returns:

The current value of SELECTABLE attribute.

setSelectable
```
public void setSelectable(logical value)
```
Set the SELECTABLE writable attribute.

Specified by:

setSelectable in interface CommonWidget

Parameters:

value - the new value of the attribute

setSelectable
```
public void setSelectable(boolean value)
```
Get the SELECTABLE writable attribute.

Specified by:

setSelectable in interface CommonWidget

Parameters:

value - the new value of the attribute

getX
```
public integer getX()
```
Blocks attempts to access this attribute.

Specified by:

getX in interface Coordinates

Returns:

nothing.

getFrameX
```
public integer getFrameX()
```
Blocks attempts to access this attribute.

Specified by:

getFrameX in interface CommonWidget

Returns:

nothing.

setX
```
public void setX(NumberType x)
```
Blocks attempts to access this attribute.

Specified by:

setX in interface Coordinates

Parameters:

x - Not used.

setX
```
public void setX(int x)
```
Blocks attempts to access this attribute.

Specified by:

setX in interface Coordinates

Parameters:

x - Not used.

getY
```
public integer getY()
```
Blocks attempts to access this attribute.

Specified by:

getY in interface Coordinates

Returns:

nothing.

getZOrderClass
```
public ZOrderClass getZOrderClass()
```
Get the Z-Order class of this widget.

Returns:

The Z-Order class of this widget.

getFrameY
```
public integer getFrameY()
```
Blocks attempts to access this attribute.

Specified by:

getFrameY in interface CommonWidget

Returns:

nothing.

setY
```
public void setY(NumberType y)
```
Blocks attempts to access this attribute.

Specified by:

setY in interface Coordinates

Parameters:

y - Not used.

setY
```
public void setY(int y)
```
Blocks attempts to access this attribute.

Specified by:

setY in interface Coordinates

Parameters:

y - Not used.

isSelected
```
public logical isSelected(character item)
```
Blocks attempts to access this widget method.

Specified by:

isSelected in interface CommonWidget

Parameters:

item - Not used.

Returns:

nothing.

isSelected
```
public logical isSelected(int64 index)
```
Blocks attempts to access this widget method.

Specified by:

isSelected in interface CommonWidget

Parameters:

index - Not used.

Returns:

nothing.

getNumColumns
```
public integer getNumColumns()
```
Blocks attempts to access this widget method.

Specified by:

getNumColumns in interface CommonWidget

Returns:

nothing.

selectAll
```
public logical selectAll()
```
Blocks attempts to access this widget method.

Specified by:

selectAll in interface CommonWidget

Returns:

nothing.

deselectRows
```
public logical deselectRows()
```
Blocks attempts to access this widget method.

Specified by:

deselectRows in interface CommonWidget

Returns:

nothing.

refresh
```
public logical refresh()
```
Blocks attempts to access this widget method.

Specified by:

refresh in interface CommonWidget

Returns:

nothing.

editUndo
```
public logical editUndo()
```
Blocks attempts to access this widget method.

Specified by:

editUndo in interface CommonWidget

Returns:

nothing.

selectFocusedRow
```
public logical selectFocusedRow()
```
Blocks attempts to access this widget method.

Specified by:

selectFocusedRow in interface CommonWidget

Returns:

nothing.

name
```
public character name()
```
Gets the widget name.

Specified by:

name in interface Nameable

Overrides:

name in class HandleChain

Returns:

The widget name or unknown value if not configured.

_name
```
public java.lang.String _name()
```
Get the name attribute of handle as a string.

Overrides:

_name in class HandleChain

Returns:

See above.

apply
```
public void apply(character event)
```
Applies an event to this widget.
This method corresponds to the Progress statement: APPLY widget

Specified by:

apply in interface CommonWidget

Parameters:

event - The name of the event.

apply
```
public void apply(java.lang.String event)
```
Applies an event to this widget.
This method corresponds to the Progress statement: APPLY widget

Specified by:

apply in interface CommonWidget

Parameters:

event - The name of the event.

apply
```
public void apply(int64 eventCode)
```
Applies an event to this widget.
This method corresponds to the Progress statement: APPLY widget

Specified by:

apply in interface CommonWidget

Parameters:

eventCode - The event code.

apply
```
public void apply(double eventCode)
```
Applies an event to this widget.
This method corresponds to the Progress statement: APPLY widget

Specified by:

apply in interface CommonWidget

Parameters:

eventCode - The event code.

colorDisplay
```
public void colorDisplay(ColorSpec cs)
```
COLOR DISPLAY

Specified by:

colorDisplay in interface CommonWidget

Parameters:

cs - Color specification.

colorPrompt
```
public void colorPrompt(ColorSpec cs)
```
COLOR PROMPT

Specified by:

colorPrompt in interface CommonWidget

Parameters:

cs - Color specification.

disable
```
public void disable()
```
Disables this widget.
This method corresponds to the Progress statement: DISABLE widget

Specified by:

disable in interface CommonWidget

enable
```
public void enable()
```
Enables this widget.
This method corresponds to the Progress statement: ENABLE widget

Specified by:

enable in interface CommonWidget

hide
```
public void hide()
```
Hides this widget.
This method corresponds to the Progress statement: HIDE widget

Specified by:

hide in interface CommonWidget

hide
```
public void hide(boolean noPause)
```
Hides this widget.
This method corresponds to the Progress statement: HIDE widget

Specified by:

hide in interface CommonWidget

Parameters:

noPause - true causes omission of any pauses which would be necessary otherwise.

preRealizeCheck
```
public boolean preRealizeCheck()
```
Reports if this widget object is valid to realize.

Specified by:

preRealizeCheck in interface CommonWidget

Returns:

true if the widget can be relized.

underline
```
public void underline()
```
Underlines this widget on the screen.
This method corresponds to the Progress statement: UNDERLINE

Specified by:

underline in interface CommonWidget

underline
```
public void underline(Stream stream)
```
Underlines this widget on the screen.
This method corresponds to the Progress statement: UNDERLINE

Specified by:

underline in interface CommonWidget

Parameters:

stream - An explicit stream which will be used for the output.

view
```
public void view()
```
Shows this widget.
This method corresponds to the Progress statement: VIEW widget

Specified by:

view in interface CommonWidget

valid
```
public boolean valid()
```
Reports if this widget object is valid for use.
The validity of the widget object is determined solely by the scope of the containing frame.

Specified by:

valid in interface CommonWidget

Specified by:

valid in interface WrappedResource

Returns:

true if we are valid (can be used).

validate
```
public java.lang.String validate(BaseDataType val,
                                 boolean ignore)
```
Processes validation rules (if they exist), error checking and anyother constraint processing that needs to be applied. This is used to check if a proposed update to a widget will pass validation.

Parameters:

val - The new value that is proposed for assignment to the widget.

ignore - If true, do not return an error when the validation expression is not defined.

Returns:

null if validation succeeds, error message otherwise.

validateFields
```
public logical validateFields()
```
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.

Specified by:

validateFields in interface CommonWidget

Returns:

true if the validation is successful.

validateFields
```
public logical validateFields(java.lang.String val)
```
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.

Specified by:

validateFields in interface CommonWidget

Parameters:

val - The only correct argument is "ENABLED-FIELDS" string. If specified, VALIDATE will check enabled fields only. Otherwise, the VALIDATE method validates all fields, whether enabled or not.

Returns:

true if the validation is successful.

validateFields
```
public logical validateFields(character val)
```
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.

Specified by:

validateFields in interface CommonWidget

Parameters:

val - The only correct argument is "ENABLED-FIELDS" string. If specified, VALIDATE will check enabled fields only. Otherwise, the VALIDATE method validates all fields, whether enabled or not.

Returns:

true if the validation is successful.

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.

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.

config
```
public T config()
```
Gets the configuration object that defines the appearance and functioning of this widget.

Specified by:

config in interface ConfigOwner<T extends WidgetConfig>

Returns:

WidgetConfig instance.

afterConfigUpdate
```
public void afterConfigUpdate(T beforeUpdate)
```
The method is called after the configuration associated with the implementor changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the configuration change.

Specified by:

afterConfigUpdate in interface ConfigOwner<T extends WidgetConfig>

Parameters:

beforeUpdate - Config reference capturing the config state before the owner's config was modified.

setHeader
```
public void setHeader(boolean header)
```
Mark widget as a header.

Specified by:

setHeader in interface CommonWidget

Parameters:

header - New value of the flag.

getScreenValue
```
public character getScreenValue()
```
Obtain the current value in the screen buffer of the backing data for this widget and return it as a 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.

Specified by:

getScreenValue in interface CommonWidget

Returns:

The value as a character type or the empty string if the screen buffer value is uninitialized.

setScreenValue
```
public final void setScreenValue(character value)
```
Set the current value in the screen buffer of the backing data for this widget. If the given value is null then this widget will be set to the uninitialized value.

Specified by:

setScreenValue in interface CommonWidget

Parameters:

value - The new value for the widget, use null to set the value as uninitialized.

setScreenValue
```
public final void setScreenValue(java.lang.String screenValue)
```
Sets the SCREEN-VALUE writable attribute.

Parameters:

screenValue - The new value for the SCREEN-VALUE attribute.

getScreenValue
```
character getScreenValue(boolean initialized,
                         BaseDataType bdt,
                         java.lang.String fmt,
                         boolean ignoreFormat)
```
Internal worker for getting the SCREEN-VALUE on a per-widget basis.

Parameters:

initialized - Flag indicating if the widget is realized or not.

bdt - The current value in the frame's buffer.

fmt - The format to be applied, in case this is a formatted value.

ignoreFormat - Flag indicating if the format needs to be ignored.

Returns:

This widget's screen-value

setScreenValue
```
boolean setScreenValue(ScreenBuffer frameBuf,
                       java.lang.Object value,
                       boolean inUIStmt)
```
Internal worker for setting the SCREEN-VALUE on a per-widget basis.

Parameters:

frameBuf - The frame buffer where to save the value.

value - The parsed value to be set via SCREEN-VALUE attribute.

inUIStmt - Flag indicating this call originates from a UI statement.

Returns:

true if the caller can proceed, as the screen-value can be set.

setScreenValue
```
boolean setScreenValue(ScreenBuffer frameBuf,
                       java.lang.Object value,
                       boolean inUIStmt,
                       character unparsedValue)
```
Internal worker for setting the SCREEN-VALUE on a per-widget basis.

Parameters:

frameBuf - The frame buffer where to save the value.

value - The parsed value to be set via SCREEN-VALUE attribute.

inUIStmt - Flag indicating this call originates from a UI statement.

unparsedValue - The value to be set via SCREEN-VALUE attribute before suffering parse changes.

Returns:

true if the caller can proceed, as the screen-value can be set.

getValidationExpression
```
ValidationExpr getValidationExpression()
```
Get validation expression associated with this widget.

Returns:

validation expression associated with this widget.

getValidationMessage
```
ValidationMsg getValidationMessage()
```
Get validation message associated with this widget.

Returns:

validation message associated with this widget.

moveToTop
```
public logical moveToTop()
```
This method implements MOVE-TO-TOP function.

Specified by:

moveToTop in interface CommonWidget

Returns:

true if operation was successful.

moveToBottom
```
public logical moveToBottom()
```
This method implements MOVE-TO-BOTTOM function.

Specified by:

moveToBottom in interface CommonWidget

Returns:

true if operation was successful.

moveAfterTabItem
```
public logical moveAfterTabItem(CommonWidget widget)
```
This method implements MOVE-AFTER-TAB function.

Specified by:

moveAfterTabItem in interface CommonWidget

Parameters:

widget - Widget reference.

Returns:

true if operation was successful.

moveAfterTabItem
```
public logical moveAfterTabItem(handle widget)
```
This method implements MOVE-AFTER-TAB function.

Specified by:

moveAfterTabItem in interface CommonWidget

Parameters:

widget - The handle of the widget after whose tab position this will be moved.

Returns:

true if operation was successful.

asWidgetHandle
```
public handle asWidgetHandle()
```
Get this widget wrapped in a handle.

Specified by:

asWidgetHandle in interface CommonWidget

Returns:

handle to this frame.

readOnlyError
```
@Deprecated
public void readOnlyError(java.lang.String attribute)
```
Deprecated.

API needed to implement read-only attribute assignment (a 4GL "feature").

Specified by:

readOnlyError in interface CommonHandle

Overrides:

readOnlyError in class HandleChain

Parameters:

attribute - The attribute's name.

readOnlyError
```
public void readOnlyError(java.lang.String attribute,
                          java.lang.Object expr)
```
Shows a specific error, as this read-only attribute was used on the right-side of an assignment. If the expr is evaluated to ? (unknown value) and this attribute does not support it, a specific error is raised.

Specified by:

readOnlyError in interface CommonHandle

Overrides:

readOnlyError in class HandleChain

Parameters:

attribute - The read-only attribute.

expr - The expression whose value was attempted to be assigned to READ-ONLY attribute.

type
```
public java.lang.String type()
```
Get the type of this handle as type of String.

Overrides:

type in class HandleResource

Returns:

See above.

getHWND
```
public integer getHWND()
```
Gets the integer value of the window containing the widget.

Specified by:

getHWND in interface CommonWidget

Returns:

The integer value, which will be the same as the widget ID.

moveBeforeTabItem
```
public logical moveBeforeTabItem(CommonWidget widget)
```
Assigns the current widget to the tab position before the specified in the same field group.

Specified by:

moveBeforeTabItem in interface CommonWidget

Parameters:

widget - The handle of the widget before whose we need to make new assignment.

Returns:

true if operation was successful.

moveBeforeTabItem
```
public logical moveBeforeTabItem(handle widget)
```
Assigns the current widget to the tab position before the specified in the same field group.

Specified by:

moveBeforeTabItem in interface CommonWidget

Parameters:

widget - The handle of the widget before whose we need to make new assignment.

Returns:

true if operation was successful.

dynamic
```
public logical dynamic()
```
Checks whether the resource is dynamic or static.

Specified by:

dynamic in interface DynamicResource

Returns:

true if the resource is dynamic, false otherwise.

_dynamic
```
public boolean _dynamic()
```
Checks whether the resource is dynamic or static.

Specified by:

_dynamic in interface DynamicResource

Returns:

true if the resource is dynamic, false otherwise.

_setDynamic
```
public void _setDynamic(boolean dynFlag)
```
Set the dynamic status of this widget.

Parameters:

dynFlag - New dynamic status for widget.

getFont
```
public integer getFont()
```
Get the FONT attribute of this widget.

Specified by:

getFont in interface CommonWidget

Returns:

A value representing an entry in the user's font-table.

setFont
```
public void setFont(long fontNum)
```
Set the FONT attribute of this widget.

Specified by:

setFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

setFont
```
public void setFont(int64 fontNum)
```
Set the FONT attribute of this widget.

Specified by:

setFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

getColumnFont
```
public integer getColumnFont()
```
Get the COLUMN-FONT attribute of this browse column widget.

Specified by:

getColumnFont in interface CommonWidget

Returns:

A value representing an entry in the user's font-table.

setNoAutoValidate
```
public void setNoAutoValidate(boolean noAutoValidate)
```
Sets the NO-AUTO-VALIDATE option.

Parameters:

noAutoValidate - true if the option is set to ON.

setColumnFont
```
public void setColumnFont(long fontNum)
```
Set the COLUMN-FONT attribute of this browse column widget.

Specified by:

setColumnFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

setColumnFont
```
public void setColumnFont(int64 fontNum)
```
Set the COLUMN-FONT attribute of this browse column widget.

Specified by:

setColumnFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

getLabelFont
```
public integer getLabelFont()
```
Get the LABEL-FONT attribute of this browse column widget.

Specified by:

getLabelFont in interface CommonWidget

Returns:

A value representing an entry in the user's font-table.

setLabelFont
```
public void setLabelFont(long fontNum)
```
Set the LABEL-FONT attribute of this browse column widget.

Specified by:

setLabelFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

setLabelFont
```
public void setLabelFont(int64 fontNum)
```
Set the LABEL-FONT attribute of this browse column widget.

Specified by:

setLabelFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

getTitleFont
```
public integer getTitleFont()
```
Get the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.

Specified by:

getTitleFont in interface CommonWidget

Returns:

A value representing an entry in the user's font-table.

setTitleFont
```
public void setTitleFont(long fontNum)
```
Set the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.

Specified by:

setTitleFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

setTitleFont
```
public void setTitleFont(int64 fontNum)
```
Set the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.

Specified by:

setTitleFont in interface CommonWidget

Parameters:

fontNum - An entry in the font-table or unknown to refer the default font.

setParent
```
public void setParent(GenericWidget<?> p)
```
Blocks attempts to access this attribute.

Specified by:

setParent in interface CommonWidget

Parameters:

p - Not used.

isThreeD
```
public logical isThreeD()
```
Blocks attempts to access this attribute.

Specified by:

isThreeD in interface CommonWidget

Returns:

true if window has THREE-D option set.

setThreeD
```
public void setThreeD(logical threeD)
```
Blocks attempts to access this attribute.

Specified by:

setThreeD in interface CommonWidget

Parameters:

threeD - Not used.

setThreeD
```
public void setThreeD(boolean threeD)
```
Blocks attempts to access this attribute.

Specified by:

setThreeD in interface CommonWidget

Parameters:

threeD - Not used.

getVirtHeight
```
public decimal getVirtHeight()
```
Blocks attempts to access this attribute.

Specified by:

getVirtHeight in interface CommonWidget

Returns:

The attribute value.

setVirtHeight
```
public void setVirtHeight(NumberType height)
```
Blocks attempts to access this attribute.

Specified by:

setVirtHeight in interface CommonWidget

Parameters:

height - Not used.

getVirtWidth
```
public decimal getVirtWidth()
```
Blocks attempts to access this attribute.

Specified by:

getVirtWidth in interface CommonWidget

Returns:

The attribute value.

setVirtWidth
```
public void setVirtWidth(NumberType width)
```
Blocks attempts to access this attribute.

Specified by:

setVirtWidth in interface CommonWidget

Parameters:

width - Not used.

getVirtHeightPixels
```
public integer getVirtHeightPixels()
```
Blocks attempts to access this attribute.

Specified by:

getVirtHeightPixels in interface CommonWidget

Returns:

The attribute value.

setVirtHeightPixels
```
public void setVirtHeightPixels(NumberType height)
```
Blocks attempts to access this attribute.

Specified by:

setVirtHeightPixels in interface CommonWidget

Parameters:

height - Not used.

getPopupMenu
```
public handle getPopupMenu()
```
Get widget POPUP-MENU.

Specified by:

getPopupMenu in interface CommonWidget

Returns:

The pop-up menu handle.

setPopupMenu
```
public void setPopupMenu(handle menu)
```
Set widget's POPUP-MENU.

Specified by:

setPopupMenu in interface CommonWidget

Parameters:

menu - The menu handle.

setPopupMenu
```
public void setPopupMenu(MenuWidget menu)
```
Set widget's POPUP-MENU.

Specified by:

setPopupMenu in interface CommonWidget

Parameters:

menu - The menu widget

openPopup
```
public void openPopup()
```
Opens the popup menu set on the widget. The menu is positioned at the current mouse cursor location. When no menu is set on the widget the method is a no-op.

Specified by:

openPopup in interface CommonWidget

detachMenu
```
void detachMenu(MenuWidget menu)
```
Detach the specified popup-menu from this widget.

Parameters:

menu - The menu to detach.

getVirtWidthPixels
```
public integer getVirtWidthPixels()
```
Blocks attempts to access this attribute.

Specified by:

getVirtWidthPixels in interface CommonWidget

Returns:

The attribute value.

setVirtWidthPixels
```
public void setVirtWidthPixels(NumberType width)
```
Blocks attempts to access this attribute.

Specified by:

setVirtWidthPixels in interface CommonWidget

Parameters:

width - Not used.

getBgColor
```
public integer getBgColor()
```
Blocks attempts to access this attribute.

Specified by:

getBgColor in interface CommonWidget

Returns:

BGCOLOR value

setBgColor
```
public void setBgColor(NumberType bgcolor)
```
Blocks attempts to access this attribute.

Specified by:

setBgColor in interface CommonWidget

Parameters:

bgcolor - Not used.

getFgColor
```
public integer getFgColor()
```
Blocks attempts to access this attribute.

Specified by:

getFgColor in interface CommonWidget

Returns:

FGCOLOR value

setFgColor
```
public void setFgColor(NumberType fgcolor)
```
Blocks attempts to access this attribute.

Specified by:

setFgColor in interface CommonWidget

Parameters:

fgcolor - Not used.

getBgColorRgb
```
public integer getBgColorRgb()
```
Blocks attempts to access this attribute.

Specified by:

getBgColorRgb in interface CommonWidget

Returns:

BGCOLOR-RGB value

setBgColorRgb
```
public void setBgColorRgb(NumberType bgcolorRgb)
```
Blocks attempts to access this attribute.

Specified by:

setBgColorRgb in interface CommonWidget

Parameters:

bgcolorRgb - Not used.

getFgColorRgb
```
public integer getFgColorRgb()
```
Blocks attempts to access this attribute.

Specified by:

getFgColorRgb in interface CommonWidget

Returns:

FGCOLOR-RGB value

setFgColorRgb
```
public void setFgColorRgb(NumberType fgcolorRgb)
```
Blocks attempts to access this attribute.

Specified by:

setFgColorRgb in interface CommonWidget

Parameters:

fgcolorRgb - Not used.

setTabStop
```
public void setTabStop(boolean value)
```
Set value of the TAB-STOP attribute.

Specified by:

setTabStop in interface CommonWidget

Parameters:

value - Value of the attribute.

setTabStop
```
public void setTabStop(logical value)
```
Set value of the TAB-STOP attribute.

Specified by:

setTabStop in interface CommonWidget

Parameters:

value - Value of the attribute.

isTabStop
```
public logical isTabStop()
```
Get value of the TAB-STOP attribute.

Specified by:

isTabStop in interface CommonWidget

Returns:

value of the attribute.

_isRealized
```
public boolean _isRealized()
```
Returns a flag indicating whether the widget has been realized.

Returns:

See above.

setWidgetId
```
public void setWidgetId(integer id)
```
Sets the WIDGET-ID writable attribute.

Specified by:

setWidgetId in interface CommonWidget

Parameters:

id - The new value for the WIDGET-ID attribute.

setWidgetId
```
public void setWidgetId(int id)
```
Sets the WIDGET-ID writable attribute.

Specified by:

setWidgetId in interface CommonWidget

Parameters:

id - The new value for the WIDGET-ID attribute.

getWidgetId
```
public integer getWidgetId()
```
Gets the WIDGET-ID writable attribute.

Specified by:

getWidgetId in interface CommonWidget

Returns:

the widget id

setContextHelpId
```
public void setContextHelpId(integer id)
```
Sets the CONTEXT-HELP-ID writable attribute.

Specified by:

setContextHelpId in interface CommonWidget

Parameters:

id - The new value for the CONTEXT-HELP-ID attribute.

setContextHelpId
```
public void setContextHelpId(int id)
```
Sets the WIDGET-ID writable attribute.

Specified by:

setContextHelpId in interface CommonWidget

Parameters:

id - The new value for the CONTEXT-HELP-ID attribute.

getContextHelpId
```
public integer getContextHelpId()
```
Gets the CONTEXT-HELP-ID writable attribute.

Specified by:

getContextHelpId in interface CommonWidget

Returns:

the widget context help id

getFrameRow
```
public decimal getFrameRow()
```
Gets the FRAME-ROW attribute.

Specified by:

getFrameRow in interface CommonWidget

Returns:

the value of the attribute

setManualHighlight
```
public void setManualHighlight(boolean value)
```
Set value of the MANUAL-HIGHLIGHT attribute.

Specified by:

setManualHighlight in interface CommonWidget

Parameters:

value - Value of the attribute.

setManualHighlight
```
public void setManualHighlight(logical value)
```
Set value of the BLANK attribute.

Specified by:

setManualHighlight in interface CommonWidget

Parameters:

value - Value of the attribute.

isManualHighlight
```
public logical isManualHighlight()
```
Get value of the MANUAL-HIGHLIGHT attribute.

Specified by:

isManualHighlight in interface CommonWidget

Returns:

value of the attribute.

setMenuMouse
```
public void setMenuMouse(int value)
```
Sets the MENU-MOUSE writable attribute.

Specified by:

setMenuMouse in interface CommonWidget

Parameters:

value - The new value for the MENU-MOUSE attribute.

setMenuMouse
```
public void setMenuMouse(int64 value)
```
Sets the MENU-MOUSE writable attribute.

Specified by:

setMenuMouse in interface CommonWidget

Parameters:

value - The new value for the MENU-MOUSE attribute.

getMenuMouse
```
public integer getMenuMouse()
```
Gets the MENU-MOUSE attribute.

Specified by:

getMenuMouse in interface CommonWidget

Returns:

the value of the attribute

setMenuKey
```
public void setMenuKey(java.lang.String value)
```
Sets the MENU-KEY writable attribute.

Specified by:

setMenuKey in interface CommonWidget

Parameters:

value - The new value for the MENU-KEY attribute.

setMenuKey
```
public void setMenuKey(character value)
```
Sets the MENU-KEY writable attribute.

Specified by:

setMenuKey in interface CommonWidget

Parameters:

value - The new value for the MENU-KEY attribute.

getMenuKey
```
public character getMenuKey()
```
Gets the MENU-KEY attribute.

Specified by:

getMenuKey in interface CommonWidget

Returns:

the value of the attribute

getWindow
```
public handle getWindow()
```
Gets the WINDOW attribute.

Specified by:

getWindow in interface CommonWidget

Returns:

the value of the attribute

isResizable
```
public logical isResizable()
```
Getter for RESIZABLE attribute.

Specified by:

isResizable in interface CommonWidget

Returns:

true if widget is resizable.

setResizable
```
public void setResizable(boolean on)
```
Setter for RESIZABLE attribute.

Specified by:

setResizable in interface CommonWidget

Parameters:

on - true to make the widget resizable

setResizable
```
public void setResizable(logical on)
```
Setter for RESIZABLE attribute.

Specified by:

setResizable in interface CommonWidget

Parameters:

on - true to make the widget resizable

loadMousePointer

public logical loadMousePointer(java.lang.String pointerName)

The implementation of LOAD-MOUSE-POINTER() method. Specifies the mouse pointer to display when the pointer is moved over the widget.

Specified by:

loadMousePointer in interface CommonWidget

Parameters:

pointerName - The name of the mouse cursor. Here is the list of all cursor names:

APPSTARTING	Arrow with an hourglass beside it
ARROW	Standard arrow cursor
CROSS	Cross hairs
HELP	Arrow with a question mark beside it
IBEAM	I-beam text cursor
NO	Circle with a slash through it
RECTANGLE (NT 3.51 only)	White rectangle
SIZE	Sizing rectangle
SIZE-E	Size to right
SIZE-N	Size to top
SIZE-NE	Size to top right
SIZE-NW	Size to top left
SIZE-S	Size to bottom
SIZE-SE	Size to bottom right
SIZE-SW	Size to bottom left
SIZE-W	Size to left
UPARROW	Up arrow
WAIT	System busy
GLOVE	Glove/finger
COMPILER-WAIT	Compiler busy

Returns:

true if the mouse pointer is loaded successfully.

loadMousePointer

public logical loadMousePointer(character pointerName)

The implementation of LOAD-MOUSE-POINTER() method. Specifies the mouse pointer to display when the pointer is moved over the widget.

Specified by:

loadMousePointer in interface CommonWidget

Parameters:

pointerName - The name of the mouse cursor. Here is the list of all cursor names:

APPSTARTING	Arrow with an hourglass beside it
ARROW	Standard arrow cursor
CROSS	Cross hairs
HELP	Arrow with a question mark beside it
IBEAM	I-beam text cursor
NO	Circle with a slash through it
RECTANGLE (NT 3.51 only)	White rectangle
SIZE	Sizing rectangle
SIZE-E	Size to right
SIZE-N	Size to top
SIZE-NE	Size to top right
SIZE-NW	Size to top left
SIZE-S	Size to bottom
SIZE-SE	Size to bottom right
SIZE-SW	Size to bottom left
SIZE-W	Size to left
UPARROW	Up arrow
WAIT	System busy
GLOVE	Glove/finger
COMPILER-WAIT	Compiler busy

Returns:

true if the mouse pointer is loaded successfully.

getMousePointer
```
public character getMousePointer()
```
Get the value of the MOUSE-POINTER attribute for a widget

Specified by:

getMousePointer in interface CommonWidget

Returns:

the value of the attribute

getMousePosition
```
public integer[] getMousePosition()
```
Returns current mouse cursor position relative to this widget. The position is returned in the result array in pixel coordinates. The method is only supported in GUI mode.
The method supports the legacy widget method GET-MOUSE-POSITION. However GET-MOUSE-POSITION is not a real 4GL method but a FWD extension to the language.

Specified by:

getMousePosition in interface CommonWidget

Returns:

mouse cursor position, never null, the array is always of length 2, where the index 0 points to the X coordinate and index 1 to the Y coordinate of the mouse cursor relative to the widget origin.

inputValue
```
public BaseDataType inputValue()
```
Reads the INPUT-VALUE attribute (value of the widget currently in the screen-buffer). TODO: should this implementation should be moved/overridden in ControlTextWidget ?

Specified by:

inputValue in interface CommonWidget

Returns:

The input value of the widget of the same data type as the field or variable associated with the widget.

getTransparent
```
public logical getTransparent()
```
Gets TRANSPARENT attribute.

Specified by:

getTransparent in interface ImageWidgetSupport

Returns:

TRANSPARENT current value.

setTransparent
```
public void setTransparent(boolean flag)
```
Set TRANSPARENT attribute.

Specified by:

setTransparent in interface ImageWidgetSupport

Parameters:

flag - New value for the attribute.

setTransparent
```
public void setTransparent(logical flag)
```
Set TRANSPARENT attribute.

Specified by:

setTransparent in interface ImageWidgetSupport

Parameters:

flag - New value for the attribute.

isReadOnly
```
public logical isReadOnly()
```
Checks whether the widget is write-protected.

Specified by:

isReadOnly in interface WriteProtectable

Returns:

true if the widget is write-protected.

setReadOnly
```
public void setReadOnly(logical r)
```
Sets the READ-ONLY attribute of the widget.

Specified by:

setReadOnly in interface WriteProtectable

Parameters:

r - true if the widget should be write-protected.

getStretchToFit
```
public logical getStretchToFit()
```
Gets STRETCH-TO-FIT attribute.

Specified by:

getStretchToFit in interface ImageWidgetSupport

Returns:

STRETCH-TO-FIT current value.

setStretchToFit
```
public void setStretchToFit(boolean flag)
```
Set STRETCH-TO-FIT attribute.

Specified by:

setStretchToFit in interface ImageWidgetSupport

Parameters:

flag - New value for the attribute.

setStretchToFit
```
public void setStretchToFit(logical flag)
```
Set STRETCH-TO-FIT attribute.

Specified by:

setStretchToFit in interface ImageWidgetSupport

Parameters:

flag - New value for the attribute.

getRetainShape
```
public logical getRetainShape()
```
Gets RETAIN-SHAPE attribute.

Specified by:

getRetainShape in interface ImageWidgetSupport

Returns:

RETAIN-SHAPE current value.

setRetainShape
```
public void setRetainShape(boolean flag)
```
Set RETAIN-SHAPE attribute.

Specified by:

setRetainShape in interface ImageWidgetSupport

Parameters:

flag - New value for the attribute.

setRetainShape
```
public void setRetainShape(logical flag)
```
Set RETAIN-SHAPE attribute.

Specified by:

setRetainShape in interface ImageWidgetSupport

Parameters:

flag - New value for the attribute.

isChecked
```
public logical isChecked()
```
Gets the CHECKED writable attribute.

Specified by:

isChecked in interface Checkable

Returns:

The current value of the CHECKED attribute.

setChecked
```
public void setChecked(boolean checked)
```
Sets the CHECKED writable attribute.

Specified by:

setChecked in interface Checkable

Parameters:

checked - The new value for the CHECKED attribute.

setChecked
```
public void setChecked(logical checked)
```
Sets the CHECKED writable attribute.

Specified by:

setChecked in interface Checkable

Parameters:

checked - The new value for the CHECKED attribute.

loadImage
```
public boolean loadImage(java.lang.String name)
```
Load widget(button or image) image from specified file name.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

Returns:

true if operation was successful.

loadImage
```
public boolean loadImage(java.lang.String name,
                         long xOffset)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage
```
public boolean loadImage(java.lang.String name,
                         long xOffset,
                         long yOffset)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage
```
public boolean loadImage(java.lang.String name,
                         long xOffset,
                         long yOffset,
                         long width)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

Returns:

true if operation was successful.

loadImage
```
public boolean loadImage(java.lang.String name,
                         long xOffset,
                         long yOffset,
                         long width,
                         long height)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

height - Specifies the number of pixels along the y-axis to read from the image file.

Returns:

true if operation was successful.

loadImage
```
public logical loadImage(character name)
```
Load widget(button or image) image from specified file name.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

Returns:

true if operation was successful.

loadImage
```
public logical loadImage(character name,
                         int64 xOffset)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage
```
public logical loadImage(character name,
                         int64 xOffset,
                         int64 yOffset)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

Returns:

true if operation was successful.

loadImage
```
public logical loadImage(character name,
                         int64 xOffset,
                         int64 yOffset,
                         int64 width)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

Returns:

true if operation was successful.

loadImage
```
public logical loadImage(character name,
                         int64 xOffset,
                         int64 yOffset,
                         int64 width,
                         int64 height)
```
Load widget(button or image) image from specified file name. This method overload allows to load only part of the image.

Specified by:

loadImage in interface ImageSupport

Parameters:

name - Image file name.

xOffset - An integer expression that specifies the pixel along the x-axis at which to begin reading from the image file.

yOffset - Specifies the pixel along the y-axis at which to begin reading from the image file.

width - Specifies the number of pixels along the x-axis to read from the image file.

height - Specifies the number of pixels along the y-axis to read from the image file.

Returns:

true if operation was successful.

getConvert3D
```
public logical getConvert3D()
```
Gets CONVERT-3D-COLORS attribute.

Specified by:

getConvert3D in interface ImageSupport

Returns:

CONVERT-3D-COLORS current value.

setConvert3D
```
public void setConvert3D(boolean flag)
```
Set CONVERT-3D-COLORS attribute.

Specified by:

setConvert3D in interface ImageSupport

Parameters:

flag - New value for the option.

setConvert3D
```
public void setConvert3D(logical flag)
```
Set CONVERT-3D-COLORS attribute.

Specified by:

setConvert3D in interface ImageSupport

Parameters:

flag - New value for the option.

isDisableRedraw
```
public logical isDisableRedraw()
```
Gets the DISABLE-REDRAW attribute. This attribute is a FWD extension, not real 4GL!

Specified by:

isDisableRedraw in interface DisableRedraw

Returns:

current value of DISABLE-REDRAW attribute.

setDisableRedraw
```
public void setDisableRedraw(boolean value)
```
Sets the DISABLE-REDRAW attribute. This attribute is a FWD extension, not real 4GL!

Specified by:

setDisableRedraw in interface DisableRedraw

Parameters:

value - Value to set to DISABLE-REDRAW attribute.

setFromOCX
```
public void setFromOCX(boolean fromOCX)
```
Marks the widget as a replacement for an OCX control.
There are some runtime requirements for widgets replacing OCX controls. One example is the TYPE property should report "CONTROL-FRAME" as OCXes are always hosted in CONTROL-FRAME widgets.

Parameters:

fromOCX - Set to true to mark the created widget as a replacement for an OCX control.

getAttr
```
public <T> T getAttr(java.lang.String fname,
                     java.util.function.Supplier<T> getter)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

Returns:

Config field value.

getAttr
```
public <T> T getAttr(java.lang.String fname,
                     java.util.function.Supplier<T> getter,
                     boolean flush)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

flush - Flag to make attribute flush before calling the getter.

Returns:

Config field value.

getAttr
```
public boolean getAttr(java.lang.String fname,
                       java.util.function.BooleanSupplier getter)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

Returns:

Config field value.

getAttr
```
public boolean getAttr(java.lang.String fname,
                       java.util.function.BooleanSupplier getter,
                       boolean flush)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

flush - Flag to make attribute flush before calling the getter.

Returns:

Config field value.

getAttr
```
public char getAttr(java.lang.String fname,
                    CharSupplier getter)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

Returns:

Config field value.

getAttr
```
public char getAttr(java.lang.String fname,
                    CharSupplier getter,
                    boolean flush)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

flush - Flag to make attribute flush before calling the getter.

Returns:

Config field value.

getAttr
```
public int getAttr(java.lang.String fname,
                   java.util.function.IntSupplier getter)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

Returns:

Config field value.

getAttr
```
public int getAttr(java.lang.String fname,
                   java.util.function.IntSupplier getter,
                   boolean flush)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

flush - Flag to make attribute flush before calling the getter.

Returns:

Config field value.

getAttr
```
public long getAttr(java.lang.String fname,
                    java.util.function.LongSupplier getter)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

Returns:

Config field value.

getAttr
```
public long getAttr(java.lang.String fname,
                    java.util.function.LongSupplier getter,
                    boolean flush)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

flush - Flag to make attribute flush before calling the getter.

Returns:

Config field value.

getAttr
```
public double getAttr(java.lang.String fname,
                      java.util.function.DoubleSupplier getter)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

Returns:

Config field value.

getAttr
```
public double getAttr(java.lang.String fname,
                      java.util.function.DoubleSupplier getter,
                      boolean flush)
```
Returns config field value.

Parameters:

fname - Config field name.

getter - Supplier responsible for retrieving the field value from the corresponding config instance.

flush - Flag to make attribute flush before calling the getter.

Returns:

Config field value.

setAttr
```
public void setAttr(java.lang.String fname,
                    boolean currentValue,
                    boolean newValue,
                    BooleanConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public void setAttr(java.lang.String fname,
                    byte currentValue,
                    byte newValue,
                    ByteConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public void setAttr(java.lang.String fname,
                    char currentValue,
                    char newValue,
                    CharConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public void setAttr(java.lang.String fname,
                    short currentValue,
                    short newValue,
                    ShortConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public void setAttr(java.lang.String fname,
                    int currentValue,
                    int newValue,
                    java.util.function.IntConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public void setAttr(java.lang.String fname,
                    long currentValue,
                    long newValue,
                    java.util.function.LongConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public void setAttr(java.lang.String fname,
                    double currentValue,
                    double newValue,
                    java.util.function.DoubleConsumer setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public <T> void setAttr(java.lang.String fname,
                        T currentValue,
                        T newValue,
                        java.util.function.Consumer<T> setter)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

setAttr
```
public <T> void setAttr(java.lang.String fname,
                        T currentValue,
                        T newValue,
                        java.util.function.Consumer<T> setter,
                        boolean force)
```
Sets config field value.

Parameters:

fname - Field name.

currentValue - Current field value.

newValue - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

force - When true the method will not perform an equality check on the current and new value.

setAttrs
```
public <T> void setAttrs(java.lang.String[] fnames,
                         T[] currentValues,
                         T[] newValues,
                         java.util.function.Consumer<T> setter)
```
Sets config field value.

Parameters:

fnames - Field names.

currentValues - Current field value.

newValues - Current field value.

setter - Consumer responsible for setting the new value in the corresponding config instance.

pushWidgetAttr
```
public void pushWidgetAttr(java.lang.String fname,
                           java.lang.Object value)
```
Push the specified widget attribute change to the client-side. The method is deprecated, use setAttr(java.lang.String, boolean, boolean, com.goldencode.util.BooleanConsumer) instead.

Parameters:

fname - The config field name.

value - The new config field value.

pushWidgetAttr
```
public void pushWidgetAttr(java.lang.String[] fnames,
                           java.lang.Object[] values)
```
Push the specified widget attribute changes to the client-side. The method is deprecated, use setAttr(java.lang.String, boolean, boolean, com.goldencode.util.BooleanConsumer) instead.

Parameters:

fnames - The list of config field names.

values - The list of new config field values.

flushWidgetAttrs
```
public void flushWidgetAttrs()
```
Performs explicit flush of enqueued config changes. This method should not be used, it currently exists only for several few places where getAttr can not be used.
WARNING: This operation is expensive since it causes a server-client round trip. Only use it if you are absolutely sure that the widget state must be immediately represented on the client side. The method is deprecated.

saveSharedState
```
void saveSharedState()
```
Save the shared state for this widget: HELP and VALEXP.

restoreSharedState
```
boolean restoreSharedState()
```
Restore the shared state for this widget: HELP and VALEXP.

Returns:

true if the shared state has been restored.

labelSizeCheck
```
protected java.lang.String labelSizeCheck(java.lang.String label)
```
Check it the requested new label size is OK for given widget.

Parameters:

label - the new label to check

Returns:

the possibly modified label string that fits particular widget constraints.

processSideLabel
```
protected int processSideLabel(boolean explicit)
```
Process the widget's side-label (if it can have one).

Parameters:

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

Returns:

The side-label widget's ID or -1 if none exists.

hasNameReadOnly
```
protected boolean hasNameReadOnly()
```
Check if this resource supports the NAME attribute in read-only mode.

Overrides:

hasNameReadOnly in class HandleChain

Returns:

Always false.

hasParent
```
protected boolean hasParent(HandleChain parent)
```
Check if this resource has as parent the specified resource.

Overrides:

hasParent in class HandleChain

Parameters:

parent - The parent for which the first child is needed. If null, the first resource with no parent set is returned.

Returns:

true if the parent is null or if the parent has the ID as set in BaseConfig.parentId.

isChained
```
protected boolean isChained()
```
Check if this resource can be reported as chained.

Overrides:

isChained in class HandleChain

Returns:

true if the widget is attached to a frame.

resourceDelete
```
protected boolean resourceDelete()
```
Delete the resource.

Overrides:

resourceDelete in class HandleResource

Returns:

true if the resource was deleted.

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 resourceDelete(), if the method returns false, the deletion is aborted.

Specified by:

delete in interface Deletable

Overrides:

delete in class HandleChain

implicitDeletion
```
protected boolean implicitDeletion()
```
Check if the resource may be implicitly deleted.

Overrides:

implicitDeletion in class HandleResource

Returns:

true if the INSTANTIATING-PROCEDURE attribute is unknown (i.e. the instantiating procedure has been deleted) and we are during finalizable or scopeable notification. true if the frame can be deleted.

canDelete
```
protected boolean canDelete()
```
Check if this resource can be deleted (implicitly or not).

Returns:

See above.

pushScreenDefinition
```
protected void pushScreenDefinition()
```
Conditionally call GenericFrame.pushScreenDefinition(), depending if the frame was set or not for this widget.

realize
```
public void realize()
```
Stub implementation of the 'realize' method. 4GL can realize widgets on access to some of its attributes

Specified by:

realize in interface CommonWidget

finishSetup
```
public void finishSetup()
```
Finish initialization of the widget.

cleanup
```
public void cleanup()
```
Cleanup the dynamic widget before deletion.

truncatePixelSize
```
protected int truncatePixelSize(int size,
                                SizeAttribute attr)
```
In 4GL the widget size (WIDTH/HEIGHT-PIXELS) can be set larger than the maximum X/Y values. Thus widget area beyond these size limits cannot be addressed. 4GL behaves very unpredictively in this case. For example when window widget is resized beyond Coordinate.MAX_GUI_PIXEL the window's message area is rendered at the Coordinate.MAX_GUI_PIXEL overlapping other widgets at the same position. We are not replicating this ill behavior. The function only detects if the size limit is reached, truncates to max supported size and creates a log entry to inform about this situation.

Parameters:

size - The value of WIDTH/HEIGHT-PIXELS attributes being assigned to the widget.

attr - The size attribute to truncate.

Returns:

The truncated size value.

getTabPosition
```
public integer getTabPosition()
```
Returns the current readable TAB-POSITION widget's attribute within its field-group. The tab position can be queried for BROWSE, BUTTON, COMBO-BOX, CONTROL-FRAME, EDITOR, FILL-IN, FRAME, RADIO-SET, SELECTION-LIST, SLIDER, TOGGLE-BOX.

Specified by:

getTabPosition in interface CommonWidget

Returns:

The current value of the TAB-POSITION attribute.

isTabWidget
```
public boolean isTabWidget()
```
Tests if this widget can be a tab item of its field-group widget. An implementation class must override this method if a widget defined by this class can't be a tab item.

Returns:

True by default

canAccess
```
protected boolean canAccess(java.lang.String attr)
```
Check if can access attribute

Parameters:

attr - name of the attribute

Returns:

true if the attrubute can be accessed

widgetName
```
protected java.lang.String widgetName()
```
Get widget name for the error message

Returns:

widget name or 'widget' string for dynamic widgets

notSettable
```
protected void notSettable(java.lang.String attr)
```
Report that the attribute is not settable

Parameters:

attr - the name of the attribute

notQueryable
```
protected void notQueryable(java.lang.String attr)
```
Report that the attribute is not queryable

Parameters:

attr - the name of the attribute

notSettable
```
protected void notSettable(java.lang.String attr,
                           boolean showError)
```
Report that the attribute is not settable

Parameters:

attr - the name of the attribute

showError - Flag indicating if the message is just shown or an ERROR condition is raised.

notQueryable
```
protected void notQueryable(java.lang.String attr,
                            boolean showError)
```
Report that the attribute is not queryable

Parameters:

attr - the name of the attribute

showError - Flag indicating if the message is just shown or an ERROR condition is raised.

notWorker
```
protected void notWorker(boolean qry,
                         java.lang.String attr,
                         boolean showError)
```
Report that the attribute is not queryable or settable.

Parameters:

qry - true for "queryable", else "setable" (yes, that is the spelling in Progress).

attr - The name of the attribute for the error message.

showError - Flag indicating if the message is just shown as a warning or an ERROR condition is raised.

genAssignUnknownWarning
```
protected void genAssignUnknownWarning(java.lang.String attr)
```
Generate the "Unable to assign UNKNOWN value to attribute" warning (4083).

Parameters:

attr - The attribute name that cannot be set.

finishConfigProcessing
```
protected void finishConfigProcessing()
```
Finish the config processing for this widget.
The default implementation is a no-op.

setScreenLock
```
protected void setScreenLock(boolean lock)
```
Lock or the the specified handle and any attribute assignments are cached until the lock is released.

Parameters:

lock - true to set the lock or false to unset it and push any changes to the client-side (if and only if the frame has been set).

moveToWorker
```
protected boolean moveToWorker(boolean top)
```
Worker for the moveToTop() and moveToBottom() code.

Parameters:

top - true if moving to top, false for bottom.

Returns:

true if move succeeded.

_setVisible
```
protected void _setVisible(boolean visible)
```
Sets the widget's config visibility flag.

Parameters:

visible - The widget's visibility state.

validateLabelAssignment
```
protected boolean validateLabelAssignment()
```
Implements legacy validations performed at side-label assignment.

Returns:

true if the validation succeeds.

setLabelInt
```
protected void setLabelInt(java.lang.String label,
                           java.lang.String untranslated)
```
Sets the label text.

Parameters:

label - The new label text.

untranslated - In case i18n is in effect, this must hold the untranslated label value and label must hold the translated label value. When i18n is not in effect, this parameter must be set to null.

getLogicalTerminal
```
protected LogicalTerminal getLogicalTerminal()
```
Returns logical terminal instance.

Returns:

See above.

canPushWidgetAttr
```
protected boolean canPushWidgetAttr()
```
Returns true if the configuration can be pushed to the client-side. This should be overriden by all widgets which have different constraints over client-side configuration transmission.

Returns:

True if the configuration can be pushed to the client-side.

setScreenValueInt
```
protected void setScreenValueInt(character value)
```
Set the current value in the screen buffer of the backing data for this widget. If the given value is null then this widget will be set to the uninitialized value.

Parameters:

value - The new value for the widget, use null to set the value as uninitialized.

setScreenValueNoErrorHandling
```
protected void setScreenValueNoErrorHandling(character value)
```
Set the current value in the screen buffer of the backing data for this widget. If the given value is null then this widget will be set to the uninitialized value. May throw ErrorConditionException.

Parameters:

value - The new value for the widget, use null to set the value as uninitialized.

warningAlreadyRealized
```
protected final void warningAlreadyRealized(java.lang.String attributeName)
```
Displays "Unable to set ATTRIBUTE_NAME because the widget has been realized." warning

Parameters:

attributeName - Attribute name used in the error message.

isExpandLabel
```
protected boolean isExpandLabel()
```
Returns state of label expansion. (Always false.)

enqueuWidgetAttr

private void enqueuWidgetAttr(int widgetId,
                              java.lang.String fname,
                              java.lang.Object value)

Enqueues widget attribute assignment.

Parameters:: widgetId - Widget id.; fname - Field name.; value - New value.

validateWorker
```
private java.lang.String validateWorker(BaseDataType newVal)
```
Processes validation rules, error checking and any other user-defined constraint processing that needs to be applied. This is used to check if a proposed update to an object will pass validation. If the method silently returns then all tests have passed, otherwise an exception will be thrown on any validation failure. Any error condition raised during the processing of the validation expression will be ignored (but will be considered a validation failure). It is expected that any error message output should already have been handled by the code that generated it. The exception is ignored here so as to not bypass the processing of the validation message evaluation AND so that this code doesn't change the control flow of the application.

Parameters:

newVal - The new value that is proposed for assignment to the widget.

Returns:

null if validation succeeded or an error message on any failure.

Class GenericWidget<T extends WidgetConfig>

Field Summary

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Methods inherited from interface com.goldencode.util.Printable

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

Field Detail

frame

config

deleted

realizeOnAttributeAccess

internalScreenValueUsage

valexp

valmsg

saveValexp

saveValmsg

menu

dynamic

frameLock

dbName

tableName

pendingScreenValue

defaultHelp

isDefaultHelp

saveDefaultHelp

saveIsDefaultHelp

saveConfigHelp

sharedStateSaved

logicalTerminal

configBatchingDisabled

selectiveConfigFlushDisabled

configDef

Constructor Detail

GenericWidget

GenericWidget

Method Detail

setFrame

setFrameHandle

setFrameHandle

setFrameHandle

setFrame

setFrame

getFrame

getFrameHandle

getFrameName

getId

setId

_isEntered

isEntered

_isNotEntered

isNotEntered

isFocusedRowSelected

setAutoReturn

setAutoReturn

isAutoReturn

setAutoResize

setAutoResize

setAutoCompletion

setAutoCompletion

isAutoCompletion

isAutoResize

setBlank

getColumn

getFrameColumn

setColumn

getColumnLabel

setColumnLabel

setColumnLabel