FrameWidget (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>
    - - com.goldencode.p2j.ui.BaseEntity<T>
      - com.goldencode.p2j.ui.PaneEntity<FrameConfig>
        
        com.goldencode.p2j.ui.FrameWidget

All Implemented Interfaces:

BoxInterface, Checkable, CommonPane, CommonWidget, ConfigOwner<FrameConfig>, CustomFont, DirectManipulation, DisableRedraw, Droppable, FrameInterface, Hoverable, ImageSupport, ImageWidgetSupport, Labels, TitledElement, TopOnlyInterface, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, CommonHandleTree, Coordinates, DatabaseInfo, Deletable, Down, DynamicResource, HasVisible, InstantiatingProcedure, IterableResource, Nameable, Sensitive, Sizeable, WrappedResource, Printable
```
public class FrameWidget
extends PaneEntity<FrameConfig>
implements FrameInterface, TopOnlyInterface, BoxInterface, CommonHandleTree, Down, Hoverable, Labels, TitledElement
```
This is the server side frame widget class which contains the client-side configuration for this frame BUT which does NOT implement any of the server side logic for frame processing.
WARNING: unlike most of the server-side widget classes, this class intentionally DOES NOT push a modified screen definition to the client when visibility/hidden/down changes occur. Such changes transfer to the client using alternate paths and since these are frequently changed, using the screen definition for such things is not acceptable.

Nested Class Summary
- Nested classes/interfaces inherited from class com.goldencode.p2j.ui.BaseEntity
  BaseEntity.CharsPixels

Field Summary

Fields
Modifier and Type Field and Description

private FieldGroup background
FIELD-GROUP containing background widgets
- Fields inherited from class com.goldencode.p2j.ui.BaseEntity
  group
- Fields inherited from class com.goldencode.p2j.ui.GenericWidget
  config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess
- Fields inherited from class com.goldencode.p2j.util.HandleChain
  name, nextSibling, prevSibling, wa
- Fields inherited from class com.goldencode.p2j.util.HandleResource
  instProc, pm

Fields
Modifier and Type	Field and Description
`private FieldGroup`	`background` FIELD-GROUP containing background widgets

Constructor Summary

Constructors
Constructor and Description
`FrameWidget()` Default constructor which can be used to create a static frame.
`FrameWidget(boolean dynamic)` Primary constructor.
`FrameWidget(boolean dynamic, FrameConfig cfg)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected decimal`	`_getHeightChars()` Gets the HEIGHT-CHARS writable attribute.
`protected integer`	`_getHeightPixels()` Gets the HEIGHT-PIXELS writable attribute.
`protected decimal`	`_getWidthChars()` Gets the WIDTH-CHARS writable attribute.
`protected integer`	`_getWidthPixels()` Gets the WIDTH-PIXELS writable attribute.
`protected void`	`_setHidden(boolean hidden)` Sets the frame's config `hidden flag`.
`protected void`	`_setVisible(boolean visible)` Sets the frame's config `visibility flag`.
`void`	`afterConfigUpdate(FrameConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`protected boolean`	`allFramesVisible()` Determine if all frames up the hierarchy are visible.
`handle`	`backgroundIteration()` Get the handle for the BACKGROUND iteration of the frame.
`decimal`	`borderBottomChars()` Get the thickness (in character units) of the border at the bottom of the frame or dialog box.
`integer`	`borderBottomPixels()` Get the thickness (in pixels) of the border at the bottom of the frame or dialog box.
`decimal`	`borderLeftChars()` Get the thickness (in character units) of the border at the left of the frame or dialog box.
`integer`	`borderLeftPixels()` Get the thickness (in pixels) of the border at the left of the frame or dialog box.
`decimal`	`borderRightChars()` Get the thickness (in character units) of the border at the right of the frame or dialog box.
`integer`	`borderRightPixels()` Get the thickness (in pixels) of the border at the right of the frame or dialog box.
`decimal`	`borderTopChars()` Get the thickness (in character units) of the border at the top of the frame or dialog box.
`integer`	`borderTopPixels()` Get the thickness (in pixels) of the border at the top of the frame or dialog box.
`handle`	`currentIteration()` Conversion of CURRENT-ITERATION attribute (KW_CUR_ITER) of frame widget.
`void`	`delete()` Perform actual delete of an resource.
`handle`	`firstChild()` Accesses the first widget in the list of contained widgets.
`FieldGroup`	`getBackground()` Get the background field group
`private double`	`getBorderSize(boolean chars, boolean row, boolean top)` Get the frame's border size.
`handle`	`getCancelButton()` Gets the cancel button for this frame.
`decimal`	`getColumn()` Gets the COLUMN writable attribute.
`comhandle`	`getComHandle()` Gets the Progress COM-HANDLE attribute.
`handle`	`getDefaultButton()` Get the default button of this frame.
`integer`	`getDown()` Gets the down frame size.
`handle`	`getFrameHandle()` Gets the containing frame instance, as a handle.
`decimal`	`getHeightChars()` Gets the HEIGHT-CHARS writable attribute.
`integer`	`getHeightPixels()` Get rectangle height pixels.
`handle`	`getIteration(int level)` Implements the GET-ITERATION() widget method.
`java.lang.String`	`getMousePointerImpl()` Get the MOUSE-POINTER attribute
`handle`	`getNextTabItem()` Calculates the next widget in the tab order.
`CommonWidget`	`getParent()` Gets the PARENT writable attribute.
`handle`	`getPreviousTabItem()` Calculates the previous widget in the tab order.
`handle`	`getPrevSibling()` Obtains the previous sibling widget in the current field group.
`decimal`	`getRow()` Gets the ROW writable 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.
`protected void`	`getSizeAttrs(java.util.List<java.lang.String> names, java.util.List<java.lang.Object> vals)` Collect the size-related attributes which can be assigned by this widget.
`integer`	`getTabPosition()` Returns the current readable TAB-POSITION widget's attribute within its field-group.
`character`	`getTitle()` Gets the TITLE writable attribute.
`integer`	`getTitleBgColor()` Gets the TITLE-BGCOLOR writable attribute.
`integer`	`getTitleDColor()` Gets the TITLE-DCOLOR writable attribute.
`integer`	`getTitleFgColor()` Gets the TITLE-FGCOLOR writable attribute.
`integer`	`getTitleFont()` Get the TITLE-FONT attribute of this browse column widget.
`protected java.lang.String[]`	`getValidParentTypes()` Returns the widget types that can act as parent for this widget.
`decimal`	`getVirtHeight()` Get VIRTUAL-HEIGHT-CHARS attribute.
`integer`	`getVirtHeightPixels()` Get VIRTUAL-HEIGHT-PIXELS attribute.
`decimal`	`getVirtWidth()` Get VIRTUAL-WIDTH-CHARS attribute.
`integer`	`getVirtWidthPixels()` Get VIRTUAL-WIDTH-PIXELS attribute.
`decimal`	`getWidthChars()` Gets the WIDTH-CHARS writable attribute.
`integer`	`getWidthPixels()` Get rectangle width pixels.
`integer`	`getX()` Gets the X writable attribute.
`integer`	`getY()` Gets the Y writable attribute.
`ZOrderClass`	`getZOrderClass()` Get the Z-Order class of this widget.
`protected boolean`	`hasParent(HandleChain parent)` Check if this resource has as parent the specified resource.
`void`	`hide(boolean noPause)` Hides this frame.
`protected boolean`	`implicitDeletion()` Check if the resource may be implicitly deleted.
`logical`	`isAttrSpace()` Gets the ATTR-SPACE writable attribute.
`logical`	`isBox()` Get the value of the BOX attribute
`logical`	`isCarefulPaint()` Get the CAREFUL-PAINT attribute.
`logical`	`isCentered()` Get the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
`boolean`	`isDialogBox()` Gets the dialog box flag.
`boolean`	`isDown()` Return `true` if frame is DOWN frame.
`logical`	`isLabels()` Gets the LABELS attribute.
`logical`	`isMovable()` Queries if the user is allowed to move this widget using direct manipulation.
`logical`	`isOverlay()` Get the OVERLAY attribute's value.
`protected boolean`	`isRootFrame()` Check if this frame is the root frame (is parented directly to a window).
`logical`	`isScrollable()` Gets the SCROLLABLE writeable attribute.
`logical`	`isSelected()` Gets the SELECTED writable attribute.
`logical`	`isSideLabels()` Get the SIDE-LABELS attribute.
`logical`	`isTopOnly()` Gets the TOP-ONLY attribute's value.
`handle`	`lastChild()` Accesses the last widget in the list of contained widgets.
`integer`	`line()` Get the current iteration number for down frame.
`protected boolean`	`moveToWorker(boolean top)` Worker for the `GenericWidget.moveToTop()` and `GenericWidget.moveToBottom()` code.
`void`	`name(character name)` Set NAME attribute.
`void`	`name(java.lang.String name)` Set NAME attribute.
`private void`	`placeFrame()` Place the frame.
`private void`	`resetVirtualSize(SizeAttribute attr)` Resets the virtual size when the frame is not scrollable and size attributes are assigned.
`protected java.lang.String`	`resolveChainType()` Resolve the resource's type, for internal management purposes.
`protected boolean`	`resourceDelete()` Delete the resource.
`void`	`setAttrSpace(boolean space)` Sets the ATTR-SPACE writable attribute.
`void`	`setAttrSpace(logical space)` Sets the ATTR-SPACE writable attribute.
`void`	`setBackground(FieldGroup background)` Set the background field group
`void`	`setBox(boolean value)` Set the value of the BOX attribute
`void`	`setBox(logical value)` Set the value of the BOX attribute
`void`	`setCancelButton(handle cancelButton)` Sets the cancel button for this frame.
`void`	`setCarefulPaint(boolean careful)` Sets the CAREFUL-PAINT attribute.
`void`	`setCarefulPaint(logical careful)` Sets the CAREFUL-PAINT attribute.
`void`	`setCentered(boolean center)` Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
`void`	`setCentered(logical center)` Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
`protected void`	`setColumnOrRow(boolean isUnknown, double value, boolean row)` Sets the row or column position for this widget.
`void`	`setCurrentIteration(handle newIter)` Set the CURRENT-ITERATION widget handle for this frame.
`void`	`setDefaultButton(handle defaultButton)` Set the default button of this frame.
`void`	`setDialogBox(boolean dialogBox)` Sets the dialog box flag.
`void`	`setDown(int64 down)` Sets the down frame size.
`void`	`setDown(long down)` Sets the down frame size.
`void`	`setFrame(GenericFrame frame)` Sets the containing frame instance.
`void`	`setHeightChars(double height)` Sets the HEIGHT-CHARS writable attribute.
`void`	`setHeightChars(NumberType height)` Sets the HEIGHT-CHARS writable attribute.
`protected void`	`setHeightCharsWorker(double height)` Sets the value for the attribute HEIGHT-CHARS in the associated config instance.
`protected void`	`setHeightImpl(int heightPixels, SizeAttribute attribute)` Implementation for both `setHeightPixels(int)` and `setHeightChars(double)`.
`void`	`setHeightPixels(int heightPixels)` Sets new value of HEIGHT-PIXELS attribute.
`void`	`setHeightPixels(NumberType heightPixels)` Sets new value of HEIGHT-PIXELS attribute.
`protected void`	`setHeightPixelsWorker(int height)` Sets the value for the attribute HEIGHT-PIXELS in the associated config instance.
`void`	`setHidden(boolean hidden)` Sets the new value for HIDDEN flag.
`void`	`setId(int id)` Sets the numeric ID of this widget (this is used as an index into the screen-buffer among other things).
`protected void`	`setInstantiatingProcedure(handle hproc)` Set the instantiating procedure for this resource.
`void`	`setLabels(boolean labels)` Sets the LABELS attribute.
`void`	`setLabels(logical labels)` Sets the LABELS attribute.
`void`	`setMousePointerName(java.lang.String name)` Set the MOUSE-POINTER attribute
`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`	`setNextTabItem(GenericWidget<?> n)` Sets the NEXT-TAB-ITEM writable attribute.
`void`	`setOverlay(boolean overlay)` Sets the OVERLAY option/attribute.
`void`	`setOverlay(logical overlay)` Sets the OVERLAY attribute.
`void`	`setParent(GenericWidget<?> widget)` Sets the PARENT writable attribute.
`protected void`	`setScreenValueInt(character value)` Set the current value in the screen buffer of the backing data for this widget.
`void`	`setScrollable(boolean scroll)` Sets the SCROLLABLE writeable attribute.
`void`	`setScrollable(logical scroll)` Sets the SCROLLABLE writeable attribute.
`void`	`setSelected(boolean sel)` Sets the SELECTED writable attribute.
`void`	`setSelected(logical sel)` Sets the SELECTED writable attribute.
`void`	`setSideLabels(boolean sideLabels)` Sets the SIDE-LABELS attribute.
`void`	`setSideLabels(logical sideLabels)` Sets the SIDE-LABELS attribute.
`protected void`	`setSizeChars(java.lang.Double value, SizeAttribute attr)` Sets one of the size char attributes, that is WIDTH-CHARS, HEIGHT-CHARS, MIN-WIDTH-CHARS, MIN-HEIGHT-CHARS, MAX-WIDTH-CHARS, MAX-HEIGHT-CHARS, VIRTUAL-WIDTH_CHARS, VIRTUAL-HEIGHT-CHARS.
`protected void`	`setSizePixels(java.lang.Integer value, SizeAttribute attr)` Sets one of the size pixel attributes, that is WIDTH-PIXELS, HEIGHT-PIXELS, MIN-WIDTH-PIXELS, MIN-HEIGHT-PIXELS, MAX-WIDTH-PIXELS, MAX-HEIGHT-PIXELS, VIRTUAL-WIDTH_PIXELS, VIRTUAL-HEIGHT-PIXELS.
`void`	`setTitle(character title)` Sets the TITLE writable attribute.
`void`	`setTitleBgColor(int64 bgcolor)` Sets the TITLE-BGCOLOR writable attribute.
`void`	`setTitleBgColor(long bgcolor)` Sets the TITLE-BGCOLOR writable attribute.
`void`	`setTitleDColor(int64 dcolor)` Sets the TITLE-DCOLOR writable attribute.
`void`	`setTitleDColor(long dcolor)` Sets the TITLE-DCOLOR writable attribute.
`void`	`setTitleFgColor(int64 fgcolor)` Sets the TITLE-FGCOLOR writable attribute.
`void`	`setTitleFgColor(long fgcolor)` Sets the TITLE-FGCOLOR writable attribute.
`void`	`setTitleFont(int64 fontNum)` Set the TITLE-FONT attribute of this browse widget.
`void`	`setTitleFont(long fontNum)` Set the TITLE-FONT attribute of this browse widget.
`void`	`setTopOnly(boolean topOnly)` Sets the TOP-ONLY option/attribute.
`void`	`setTopOnly(logical topOnly)` Sets the TOP-ONLY option/attribute.
`void`	`setVisible(boolean visible)` Sets the Progress VISIBLE attribute.
`protected void`	`setWidthCharsWorker(double width)` Sets the value for the attribute WIDTH-CHARS in the associated config instance.
`protected void`	`setWidthImpl(int widthPixels, SizeAttribute attribute)` Implementation for both `BaseEntity.setWidthPixels(int)` and `BaseEntity.setWidthChars(double)`.
`protected void`	`setWidthPixelsWorker(int width)` Sets the value for the attribute WIDTH-PIXELS in the associated config instance.
`protected void`	`setXorY(boolean isUnknown, int value, boolean x)` Sets the X or Y position for this widget.
`java.lang.String`	`type()` If this is a dialog-box frame, then its type must be `DIALOG-BOX`.
`protected boolean`	`useHandleChainSiblings()` Indicates an implementation of siblings methods.
`logical`	`validateFields(boolean enabledOnly)` Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied.
`protected boolean`	`validateParent(GenericWidget<?> widget)` Checks whether the supplied widget can be used as a valid parent of this widget.
`protected boolean`	`validateSize(java.lang.Number value, SizeAttribute attr)` Performs a validation of widget size value.
`void`	`view()` Views this frame.

Methods inherited from class com.goldencode.p2j.ui.BaseEntity
canSetPixelPositionInChui, changeFontWorker, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getNextSibling, getParent, getPfColor, getTooltip, isFontBold, isFontItalic, isFontUnderline, isResizable, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSystemParent, setTabStop, setTabStop, setTitle, setTooltip, setTooltip, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels, setX, setX, setXOrYWorker, setY, setY, validColumnOrRow

Methods inherited from class com.goldencode.p2j.ui.GenericWidget
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _name, _setDynamic, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getQuery, getRetainShape, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTransparent, getValidationExpression, getValidationMessage, getWidgetId, getWidth, getWindow, hasFormat, hasNameReadOnly, hide, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChained, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isSelectable, isSelected, isSelected, isSensitive, isTabWidget, isTextSelected, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTabItem, moveAfterTabItem, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, processSideLabel, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setAutoCompletion, setAutoCompletion, setAutoResize, setAutoResize, setAutoReturn, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMultiple, setMultiple, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValue, setScreenValueNoErrorHandling, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVisible, setWidgetId, setWidgetId, setWidth, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateLabelAssignment, warningAlreadyRealized, widgetName

Methods inherited from class com.goldencode.p2j.util.HandleChain
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, 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, 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.util.IterableResource
getIteration

Methods inherited from interface com.goldencode.p2j.ui.Droppable
endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget

Methods inherited from interface com.goldencode.p2j.ui.DirectManipulation
setBoxSelectable, setGridFactorHorizontal, setGridFactorVertical, setGridSnap, setGridUnitHeightChars, setGridUnitHeightPixels, setGridUnitWidthChars, setGridUnitWidthPixels, setGridVisible

Methods inherited from interface com.goldencode.p2j.ui.CommonWidget
getIdEx, getListItems, isEditCanUndo, setListItems, setListItems, setScreenValue

Methods inherited from interface com.goldencode.p2j.util.CommonHandleChain
getPrivateData, setPrivateData, setPrivateData

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

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.p2j.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
  - background
```
private FieldGroup background
```
    FIELD-GROUP containing background widgets
- Constructor Detail
  - FrameWidget
```
public FrameWidget()
```
    Default constructor which can be used to create a static frame.
  - FrameWidget
```
public FrameWidget(boolean dynamic)
```
    Primary constructor.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
  - FrameWidget
```
public FrameWidget(boolean dynamic,
                   FrameConfig cfg)
```
    Constructor.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
    
    cfg - The configuration to use. If null the widget will create new default instance.
- Method Detail
  - 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
    
    Overrides:
    
    setId in class GenericWidget<FrameConfig>
    
    Parameters:
    
    id - The numeric ID of this widget.
  - type
```
public java.lang.String type()
```
    If this is a dialog-box frame, then its type must be DIALOG-BOX. Otherwise, its type is FRAME.
    
    Overrides:
    
    type in class GenericWidget<FrameConfig>
    
    Returns:
    
    See above.
  - name
```
public void name(java.lang.String name)
```
    Set NAME attribute.
    
    Specified by:
    
    name in interface Nameable
    
    Overrides:
    
    name in class HandleChain
    
    Parameters:
    
    name - New value for the attribute.
  - name
```
public void name(character name)
```
    Set NAME attribute.
    
    Specified by:
    
    name in interface Nameable
    
    Overrides:
    
    name in class HandleChain
    
    Parameters:
    
    name - New value for the attribute.
  - getPrevSibling
```
public handle getPrevSibling()
```
    Obtains the previous sibling widget in the current field group.
    
    Specified by:
    
    getPrevSibling in interface CommonHandleChain
    
    Overrides:
    
    getPrevSibling in class BaseEntity<FrameConfig>
    
    Returns:
    
    The previous sibling or an unknown handle if this only widget or if this is the first widget.
  - setNextTabItem
```
public void setNextTabItem(GenericWidget<?> n)
```
    Sets the NEXT-TAB-ITEM writable attribute.
    
    Specified by:
    
    setNextTabItem in interface CommonWidget
    
    Overrides:
    
    setNextTabItem in class GenericWidget<FrameConfig>
    
    Parameters:
    
    n - The new value for the NEXT-TAB-ITEM attribute.
  - 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
    
    Overrides:
    
    getScreenValue in class GenericWidget<FrameConfig>
    
    Returns:
    
    The value as a character type or the empty string if the screen buffer value is uninitialized.
  - 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.
    
    Overrides:
    
    setScreenValueInt in class GenericWidget<FrameConfig>
    
    Parameters:
    
    value - The new value for the widget, use null to set the value as uninitialized.
  - isCarefulPaint
```
public logical isCarefulPaint()
```
    Get the CAREFUL-PAINT attribute.
    
    Specified by:
    
    isCarefulPaint in interface FrameInterface
    
    Returns:
    
    true if the attribute is ON.
  - setCarefulPaint
```
public void setCarefulPaint(logical careful)
```
    Sets the CAREFUL-PAINT attribute.
    
    Specified by:
    
    setCarefulPaint in interface FrameInterface
    
    Parameters:
    
    careful - true if the attribute is set to ON.
  - setCarefulPaint
```
public void setCarefulPaint(boolean careful)
```
    Sets the CAREFUL-PAINT attribute.
    
    Specified by:
    
    setCarefulPaint in interface FrameInterface
    
    Parameters:
    
    careful - true if the attribute is set to ON.
  - isAttrSpace
```
public logical isAttrSpace()
```
    Gets the ATTR-SPACE writable attribute.
    
    Returns:
    
    The current value of the ATTR-SPACE attribute.
  - setAttrSpace
```
public void setAttrSpace(logical space)
```
    Sets the ATTR-SPACE writable attribute.
    
    Parameters:
    
    space - The new value for the ATTR-SPACE attribute.
  - setAttrSpace
```
public void setAttrSpace(boolean space)
```
    Sets the ATTR-SPACE writable attribute.
    
    Parameters:
    
    space - The new value for the ATTR-SPACE attribute.
  - isCentered
```
public logical isCentered()
```
    Get the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
    
    Specified by:
    
    isCentered in interface FrameInterface
    
    Returns:
    
    true if the frame is centered.
  - setCentered
```
public void setCentered(boolean center)
```
    Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
    
    Specified by:
    
    setCentered in interface FrameInterface
    
    Parameters:
    
    center - true if the frame is to be centered.
  - setCentered
```
public void setCentered(logical center)
```
    Set the value of the CENTERED attribute which defines if the frame is to be centered in the width of the parent window.
    
    Specified by:
    
    setCentered in interface FrameInterface
    
    Parameters:
    
    center - true if the frame is to be centered.
  - getDefaultButton
```
public handle getDefaultButton()
```
    Get the default button of this frame.
    
    Specified by:
    
    getDefaultButton in interface FrameInterface
    
    Returns:
    
    handle to current default button.
  - setDefaultButton
```
public void setDefaultButton(handle defaultButton)
```
    Set the default button of this frame.
    
    Specified by:
    
    setDefaultButton in interface FrameInterface
    
    Parameters:
    
    defaultButton - handle to current default button.
  - getCancelButton
```
public handle getCancelButton()
```
    Gets the cancel button for this frame.
    
    Specified by:
    
    getCancelButton in interface FrameInterface
    
    Returns:
    
    button widget that receives the CHOOSE event when a user cancels the current frame or dialog box by pressing the ESC key.
  - setCancelButton
```
public void setCancelButton(handle cancelButton)
```
    Sets the cancel button for this frame.
    
    Specified by:
    
    setCancelButton in interface FrameInterface
    
    Parameters:
    
    cancelButton - button widget that receives the CHOOSE event when a user cancels the current frame or dialog box by pressing the ESC key.
  - currentIteration
```
public handle currentIteration()
```
    Conversion of CURRENT-ITERATION attribute (KW_CUR_ITER) of frame widget. Getter of CURRENT-ITERATION attribute.
    
    Specified by:
    
    currentIteration in interface IterableResource
    
    Returns:
    
    current value of CURRENT-ITERATION attribute.
  - setCurrentIteration
```
public void setCurrentIteration(handle newIter)
```
    Set the CURRENT-ITERATION widget handle for this frame. This attribute is writable only for frames.
    
    Specified by:
    
    setCurrentIteration in interface IterableResource
    
    Parameters:
    
    newIter - A handle for the current iteration of the frame.
  - borderTopChars
```
public decimal borderTopChars()
```
    Get the thickness (in character units) of the border at the top of the frame or dialog box.
    
    Specified by:
    
    borderTopChars in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderLeftChars
```
public decimal borderLeftChars()
```
    Get the thickness (in character units) of the border at the left of the frame or dialog box.
    
    Specified by:
    
    borderLeftChars in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderRightChars
```
public decimal borderRightChars()
```
    Get the thickness (in character units) of the border at the right of the frame or dialog box.
    
    Specified by:
    
    borderRightChars in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderBottomChars
```
public decimal borderBottomChars()
```
    Get the thickness (in character units) of the border at the bottom of the frame or dialog box.
    
    Specified by:
    
    borderBottomChars in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderTopPixels
```
public integer borderTopPixels()
```
    Get the thickness (in pixels) of the border at the top of the frame or dialog box.
    
    Specified by:
    
    borderTopPixels in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderLeftPixels
```
public integer borderLeftPixels()
```
    Get the thickness (in pixels) of the border at the left of the frame or dialog box.
    
    Specified by:
    
    borderLeftPixels in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderRightPixels
```
public integer borderRightPixels()
```
    Get the thickness (in pixels) of the border at the right of the frame or dialog box.
    
    Specified by:
    
    borderRightPixels in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - borderBottomPixels
```
public integer borderBottomPixels()
```
    Get the thickness (in pixels) of the border at the bottom of the frame or dialog box.
    
    Specified by:
    
    borderBottomPixels in interface FrameInterface
    
    Returns:
    
    the thickness of the border at the top of the frame.
    
    See Also:
    
    getBorderSize(boolean, boolean, boolean)
  - setDialogBox
```
public void setDialogBox(boolean dialogBox)
```
    Sets the dialog box flag.
    
    Parameters:
    
    dialogBox - new value for the dialog box flag
  - isDialogBox
```
public boolean isDialogBox()
```
    Gets the dialog box flag.
    
    Returns:
    
    true if this frame is a dialog box.
  - setDown
```
public void setDown(int64 down)
```
    Sets the down frame size.
    
    Specified by:
    
    setDown in interface Down
    
    Parameters:
    
    down - The new number of iterations for this down frame.
  - setDown
```
public void setDown(long down)
```
    Sets the down frame size.
    
    Specified by:
    
    setDown in interface Down
    
    Parameters:
    
    down - The new number of iterations for this down frame.
  - getDown
```
public integer getDown()
```
    Gets the down frame size.
    
    Specified by:
    
    getDown in interface Down
    
    Returns:
    
    The number of data iterations for the frame (1 if the frame is not a down frame).
  - isDown
```
public boolean isDown()
```
    Return true if frame is DOWN frame.
    
    Returns:
    
    true if frame is DOWN frame.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Sets the new value for HIDDEN flag.
    
    Specified by:
    
    setHidden in interface CommonWidget
    
    Overrides:
    
    setHidden in class GenericWidget<FrameConfig>
    
    Parameters:
    
    hidden - The new boolean value for the HIDDEN attribute.
  - setVisible
```
public void setVisible(boolean visible)
```
    Sets the Progress VISIBLE attribute.
    
    Specified by:
    
    setVisible in interface HasVisible
    
    Overrides:
    
    setVisible in class GenericWidget<FrameConfig>
    
    Parameters:
    
    visible - The new value for the Progress VISIBLE attribute.
  - getComHandle
```
public comhandle getComHandle()
```
    Gets the Progress COM-HANDLE attribute.
    This is a non-functional stub for now.
    
    Returns:
    
    The value for the COM-HANDLE attribute.
  - hide
```
public void hide(boolean noPause)
```
    Hides this frame.
    This method corresponds to the Progress statement: HIDE FRAME
    
    Specified by:
    
    hide in interface CommonWidget
    
    Overrides:
    
    hide in class GenericWidget<FrameConfig>
    
    Parameters:
    
    noPause - true causes omission of any pauses which would be necessary otherwise.
  - view
```
public void view()
```
    Views this frame.
    This method corresponds to the Progress statement: VIEW FRAME
    
    Specified by:
    
    view in interface CommonWidget
    
    Overrides:
    
    view in class GenericWidget<FrameConfig>
  - isSelected
```
public logical isSelected()
```
    Gets the SELECTED writable attribute.
    
    Specified by:
    
    isSelected in interface CommonWidget
    
    Overrides:
    
    isSelected in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the SELECTED attribute.
  - setSelected
```
public void setSelected(logical sel)
```
    Sets the SELECTED writable attribute.
    
    Specified by:
    
    setSelected in interface CommonWidget
    
    Overrides:
    
    setSelected in class BaseEntity<FrameConfig>
    
    Parameters:
    
    sel - The new value for the SELECTED attribute.
  - setSelected
```
public void setSelected(boolean sel)
```
    Sets the SELECTED writable attribute.
    
    Specified by:
    
    setSelected in interface CommonWidget
    
    Overrides:
    
    setSelected in class BaseEntity<FrameConfig>
    
    Parameters:
    
    sel - The new value for the SELECTED attribute.
  - setSideLabels
```
public void setSideLabels(boolean sideLabels)
```
    Sets the SIDE-LABELS attribute.
    
    Specified by:
    
    setSideLabels in interface FrameInterface
    
    Parameters:
    
    sideLabels - true if the attribute is set to ON.
  - setSideLabels
```
public void setSideLabels(logical sideLabels)
```
    Sets the SIDE-LABELS attribute.
    
    Specified by:
    
    setSideLabels in interface FrameInterface
    
    Parameters:
    
    sideLabels - true if the attribute is set to ON.
  - isSideLabels
```
public logical isSideLabels()
```
    Get the SIDE-LABELS attribute.
    
    Specified by:
    
    isSideLabels in interface FrameInterface
    
    Returns:
    
    true if the attribute is ON.
  - isLabels
```
public logical isLabels()
```
    Gets the LABELS attribute.
    
    Specified by:
    
    isLabels in interface Labels
    
    Returns:
    
    the current value of the LABELS attribute.
  - setLabels
```
public void setLabels(logical labels)
```
    Sets the LABELS attribute.
    
    Specified by:
    
    setLabels in interface Labels
    
    Parameters:
    
    labels - The new value for the LABELS attribute.
  - setLabels
```
public void setLabels(boolean labels)
```
    Sets the LABELS attribute.
    
    Specified by:
    
    setLabels in interface Labels
    
    Parameters:
    
    labels - The new value for the LABELS attribute.
  - isMovable
```
public logical isMovable()
```
    Queries if the user is allowed to move this widget using direct manipulation.
    
    Specified by:
    
    isMovable in interface CommonWidget
    
    Overrides:
    
    isMovable in class BaseEntity<FrameConfig>
    
    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
    
    Overrides:
    
    setMovable in class BaseEntity<FrameConfig>
    
    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
    
    Overrides:
    
    setMovable in class BaseEntity<FrameConfig>
    
    Parameters:
    
    movable - true to enable movable direct manipulation.
  - isScrollable
```
public logical isScrollable()
```
    Gets the SCROLLABLE writeable attribute.
    
    Specified by:
    
    isScrollable in interface CommonWidget
    
    Overrides:
    
    isScrollable in class GenericWidget<FrameConfig>
    
    Returns:
    
    The current value of the SCROLLABLE attribute.
  - setScrollable
```
public void setScrollable(logical scroll)
```
    Sets the SCROLLABLE writeable attribute.
    
    Specified by:
    
    setScrollable in interface CommonWidget
    
    Overrides:
    
    setScrollable in class GenericWidget<FrameConfig>
    
    Parameters:
    
    scroll - The new value for the SCROLLABLE attribute.
  - setScrollable
```
public void setScrollable(boolean scroll)
```
    Sets the SCROLLABLE writeable attribute.
    
    Specified by:
    
    setScrollable in interface CommonWidget
    
    Overrides:
    
    setScrollable in class GenericWidget<FrameConfig>
    
    Parameters:
    
    scroll - The new value for the SCROLLABLE attribute.
  - firstChild
```
public handle firstChild()
```
    Accesses the first widget in the list of contained widgets.
    
    Specified by:
    
    firstChild in interface CommonHandleTree
    
    Returns:
    
    The first widget or null if no widgets are contained.
  - lastChild
```
public handle lastChild()
```
    Accesses the last widget in the list of contained widgets.
    
    Specified by:
    
    lastChild in interface CommonHandleTree
    
    Returns:
    
    The last widget or null if no widgets are contained.
  - setFrame
```
public void setFrame(GenericFrame frame)
```
    Sets the containing frame instance.
    
    Specified by:
    
    setFrame in interface CommonWidget
    
    Overrides:
    
    setFrame in class GenericWidget<FrameConfig>
    
    Parameters:
    
    frame - The containing instance.
  - getNextTabItem
```
public handle getNextTabItem()
```
    Calculates the next widget in the tab order. It returns the value of NEXT-TAB-ITEM legacy attribute.
    
    Specified by:
    
    getNextTabItem in interface CommonWidget
    
    Overrides:
    
    getNextTabItem in class GenericWidget<FrameConfig>
    
    Returns:
    
    The next widget or null if this widget is the last.
  - getPreviousTabItem
```
public handle getPreviousTabItem()
```
    Calculates the previous widget in the tab order. It returns the value of PREV-TAB-ITEM legacy attribute.
    
    Specified by:
    
    getPreviousTabItem in interface CommonWidget
    
    Overrides:
    
    getPreviousTabItem in class GenericWidget<FrameConfig>
    
    Returns:
    
    The previous widget or null if this widget is the last.
  - useHandleChainSiblings
```
protected boolean useHandleChainSiblings()
```
    Indicates an implementation of siblings methods.
    
    Overrides:
    
    useHandleChainSiblings in class BaseEntity<FrameConfig>
    
    Returns:
    
    Always true.
  - isBox
```
public logical isBox()
```
    Get the value of the BOX attribute
    
    Specified by:
    
    isBox in interface BoxInterface
    
    Returns:
    
    the value of the attribute
  - setBox
```
public void setBox(logical value)
```
    Set the value of the BOX attribute
    
    Specified by:
    
    setBox in interface BoxInterface
    
    Parameters:
    
    value - the new value of the attribute
  - setBox
```
public void setBox(boolean value)
```
    Set the value of the BOX attribute
    
    Specified by:
    
    setBox in interface BoxInterface
    
    Parameters:
    
    value - the new value of the attribute
  - setTopOnly
```
public void setTopOnly(boolean topOnly)
```
    Sets the TOP-ONLY option/attribute.
    
    Specified by:
    
    setTopOnly in interface TopOnlyInterface
    
    Parameters:
    
    topOnly - true if the option/attribute is set to ON.
  - setTopOnly
```
public void setTopOnly(logical topOnly)
```
    Sets the TOP-ONLY option/attribute.
    
    Specified by:
    
    setTopOnly in interface TopOnlyInterface
    
    Parameters:
    
    topOnly - true if the attribute is set to ON.
  - isTopOnly
```
public logical isTopOnly()
```
    Gets the TOP-ONLY attribute's value.
    
    Specified by:
    
    isTopOnly in interface TopOnlyInterface
    
    Returns:
    
    the value of the attribute
  - setOverlay
```
public void setOverlay(boolean overlay)
```
    Sets the OVERLAY option/attribute.
    
    Specified by:
    
    setOverlay in interface FrameInterface
    
    Parameters:
    
    overlay - true if the option/attribute is set to ON.
  - setOverlay
```
public void setOverlay(logical overlay)
```
    Sets the OVERLAY attribute.
    
    Specified by:
    
    setOverlay in interface FrameInterface
    
    Parameters:
    
    overlay - true if the attribute is set to ON.
  - isOverlay
```
public logical isOverlay()
```
    Get the OVERLAY attribute's value.
    
    Specified by:
    
    isOverlay in interface FrameInterface
    
    Returns:
    
    the value of the attribute
  - setBackground
```
public void setBackground(FieldGroup background)
```
    Set the background field group
    
    Parameters:
    
    background - background fieldgroup
  - getBackground
```
public FieldGroup getBackground()
```
    Get the background field group
    
    Returns:
    
    background field group
  - backgroundIteration
```
public handle backgroundIteration()
```
    Get the handle for the BACKGROUND iteration of the frame.
    
    Specified by:
    
    backgroundIteration in interface FrameInterface
    
    Returns:
    
    the handle for the background iteration of the frame.
  - validateFields
```
public logical validateFields(boolean enabledOnly)
```
    Processes validation rules (if they exist), error checking and any other constraint processing that needs to be applied. This is used to check if a proposed update to an object will pass validation.
    
    Overrides:
    
    validateFields in class GenericWidget<FrameConfig>
    
    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.
  - setMousePointerName
```
public void setMousePointerName(java.lang.String name)
```
    Set the MOUSE-POINTER attribute
    
    Specified by:
    
    setMousePointerName in interface Hoverable
    
    Parameters:
    
    name - the attribute value
  - getMousePointerImpl
```
public java.lang.String getMousePointerImpl()
```
    Get the MOUSE-POINTER attribute
    
    Specified by:
    
    getMousePointerImpl in interface Hoverable
    
    Returns:
    
    the attribute value
  - setParent
```
public void setParent(GenericWidget<?> widget)
```
    Sets the PARENT writable attribute.
    
    Specified by:
    
    setParent in interface CommonWidget
    
    Overrides:
    
    setParent in class BaseEntity<FrameConfig>
    
    Parameters:
    
    widget - The new value for the PARENT attribute.
  - implicitDeletion
```
protected boolean implicitDeletion()
```
    Check if the resource may be implicitly deleted.
    
    Overrides:
    
    implicitDeletion in class GenericWidget<FrameConfig>
    
    Returns:
    
    true if the INSTANTIATING-PROCEDURE attribute is unknown (i.e. the instantiating procedure has been deleted).
  - getParent
```
public CommonWidget getParent()
```
    Gets the PARENT writable attribute.
    For FRAMEs, this is either the containing WINDOW or the parent FIELD-GROUP, if attached to a frame.
    
    Specified by:
    
    getParent in interface CommonWidget
    
    Overrides:
    
    getParent in class BaseEntity<FrameConfig>
    
    Returns:
    
    the parent widget for this frame
  - hasParent
```
protected boolean hasParent(HandleChain parent)
```
    Check if this resource has as parent the specified resource.
    
    Overrides:
    
    hasParent in class GenericWidget<FrameConfig>
    
    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.
  - getFrameHandle
```
public handle getFrameHandle()
```
    Gets the containing frame instance, as a handle.
    
    Specified by:
    
    getFrameHandle in interface CommonWidget
    
    Overrides:
    
    getFrameHandle in class GenericWidget<FrameConfig>
    
    Returns:
    
    The frame that contains this widget.
  - isRootFrame
```
protected boolean isRootFrame()
```
    Check if this frame is the root frame (is parented directly to a window).
    
    Returns:
    
    See above.
  - allFramesVisible
```
protected boolean allFramesVisible()
```
    Determine if all frames up the hierarchy are visible.
    
    Returns:
    
    true if all frame's ascendants are visible.
  - afterConfigUpdate
```
public void afterConfigUpdate(FrameConfig 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<FrameConfig>
    
    Overrides:
    
    afterConfigUpdate in class GenericWidget<FrameConfig>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - 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).
    
    Specified by:
    
    delete in interface Deletable
    
    Overrides:
    
    delete in class GenericWidget<FrameConfig>
  - getWidthChars
```
public decimal getWidthChars()
```
    Gets the WIDTH-CHARS writable attribute.
    
    Specified by:
    
    getWidthChars in interface Sizeable
    
    Overrides:
    
    getWidthChars in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the WIDTH-CHARS attribute.
  - getHeightChars
```
public decimal getHeightChars()
```
    Gets the HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    getHeightChars in interface Sizeable
    
    Overrides:
    
    getHeightChars in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the HEIGHT-CHARS attribute.
  - setHeightChars
```
public void setHeightChars(NumberType height)
```
    Sets the HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    setHeightChars in interface Sizeable
    
    Overrides:
    
    setHeightChars in class BaseEntity<FrameConfig>
    
    Parameters:
    
    height - The new value for the HEIGHT-CHARS attribute.
  - setHeightChars
```
public void setHeightChars(double height)
```
    Sets the HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    setHeightChars in interface Sizeable
    
    Overrides:
    
    setHeightChars in class BaseEntity<FrameConfig>
    
    Parameters:
    
    height - The new value for the HEIGHT-CHARS attribute.
  - getWidthPixels
```
public integer getWidthPixels()
```
    Get rectangle width pixels. SIZE-PIXELS option.
    
    Specified by:
    
    getWidthPixels in interface Sizeable
    
    Overrides:
    
    getWidthPixels in class BaseEntity<FrameConfig>
    
    Returns:
    
    The width of the widget in pixels.
  - getHeightPixels
```
public integer getHeightPixels()
```
    Get rectangle height pixels. SIZE-PIXELS option.
    
    Specified by:
    
    getHeightPixels in interface Sizeable
    
    Overrides:
    
    getHeightPixels in class BaseEntity<FrameConfig>
    
    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
    
    Overrides:
    
    setHeightPixels in class BaseEntity<FrameConfig>
    
    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
    
    Overrides:
    
    setHeightPixels in class BaseEntity<FrameConfig>
    
    Parameters:
    
    heightPixels - new value of HEIGHT-PIXELS attribute
  - getVirtWidth
```
public decimal getVirtWidth()
```
    Get VIRTUAL-WIDTH-CHARS attribute.
    
    Specified by:
    
    getVirtWidth in interface CommonWidget
    
    Overrides:
    
    getVirtWidth in class PaneEntity<FrameConfig>
    
    Returns:
    
    The attribute value.
  - getVirtHeight
```
public decimal getVirtHeight()
```
    Get VIRTUAL-HEIGHT-CHARS attribute.
    
    Specified by:
    
    getVirtHeight in interface CommonWidget
    
    Overrides:
    
    getVirtHeight in class PaneEntity<FrameConfig>
    
    Returns:
    
    The attribute value.
  - getVirtWidthPixels
```
public integer getVirtWidthPixels()
```
    Get VIRTUAL-WIDTH-PIXELS attribute.
    
    Specified by:
    
    getVirtWidthPixels in interface CommonWidget
    
    Overrides:
    
    getVirtWidthPixels in class PaneEntity<FrameConfig>
    
    Returns:
    
    The attribute value.
  - getVirtHeightPixels
```
public integer getVirtHeightPixels()
```
    Get VIRTUAL-HEIGHT-PIXELS attribute.
    
    Specified by:
    
    getVirtHeightPixels in interface CommonWidget
    
    Overrides:
    
    getVirtHeightPixels in class PaneEntity<FrameConfig>
    
    Returns:
    
    The attribute value.
  - getRow
```
public decimal getRow()
```
    Gets the ROW writable attribute.
    
    Specified by:
    
    getRow in interface Coordinates
    
    Overrides:
    
    getRow in class BaseEntity<FrameConfig>
    
    Returns:
    
    The 1-based row number at which to start displaying the widget. This is converted from a 0-based row number for the internal runtime.
  - getColumn
```
public decimal getColumn()
```
    Gets the COLUMN writable attribute.
    
    Specified by:
    
    getColumn in interface Coordinates
    
    Overrides:
    
    getColumn in class BaseEntity<FrameConfig>
    
    Returns:
    
    The 1-based column number at which to start displaying the widget. This is converted from a 0-based column number for the internal runtime.
  - getX
```
public integer getX()
```
    Gets the X writable attribute.
    
    Specified by:
    
    getX in interface Coordinates
    
    Overrides:
    
    getX in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the X attribute.
  - getY
```
public integer getY()
```
    Gets the Y writable attribute.
    
    Specified by:
    
    getY in interface Coordinates
    
    Overrides:
    
    getY in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the Y attribute.
  - getZOrderClass
```
public ZOrderClass getZOrderClass()
```
    Get the Z-Order class of this widget.
    
    Overrides:
    
    getZOrderClass in class GenericWidget<FrameConfig>
    
    Returns:
    
    The Z-Order class of this widget.
  - setTitle
```
public void setTitle(character title)
```
    Sets the TITLE writable attribute.
    
    Specified by:
    
    setTitle in interface CommonWidget
    
    Overrides:
    
    setTitle in class BaseEntity<FrameConfig>
    
    Parameters:
    
    title - The new value for the TITLE attribute.
  - getTitle
```
public character getTitle()
```
    Gets the TITLE writable attribute.
    
    Specified by:
    
    getTitle in interface CommonWidget
    
    Overrides:
    
    getTitle in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the TITLE attribute.
  - getTitleBgColor
```
public integer getTitleBgColor()
```
    Gets the TITLE-BGCOLOR writable attribute.
    
    Specified by:
    
    getTitleBgColor in interface TitledElement
    
    Returns:
    
    The current value of the TITLE-BGCOLOR attribute.
  - setTitleBgColor
```
public void setTitleBgColor(int64 bgcolor)
```
    Sets the TITLE-BGCOLOR writable attribute.
    
    Specified by:
    
    setTitleBgColor in interface TitledElement
    
    Parameters:
    
    bgcolor - The new value for the TITLE-BGCOLOR attribute.
  - setTitleBgColor
```
public void setTitleBgColor(long bgcolor)
```
    Sets the TITLE-BGCOLOR writable attribute.
    
    Specified by:
    
    setTitleBgColor in interface TitledElement
    
    Parameters:
    
    bgcolor - The new value for the TITLE-BGCOLOR attribute.
  - getTitleDColor
```
public integer getTitleDColor()
```
    Gets the TITLE-DCOLOR writable attribute.
    
    Specified by:
    
    getTitleDColor in interface TitledElement
    
    Returns:
    
    The current value of the TITLE-DCOLOR attribute.
  - setTitleDColor
```
public void setTitleDColor(int64 dcolor)
```
    Sets the TITLE-DCOLOR writable attribute.
    
    Specified by:
    
    setTitleDColor in interface TitledElement
    
    Parameters:
    
    dcolor - The new value for the TITLE-DCOLOR attribute.
  - setTitleDColor
```
public void setTitleDColor(long dcolor)
```
    Sets the TITLE-DCOLOR writable attribute.
    
    Specified by:
    
    setTitleDColor in interface TitledElement
    
    Parameters:
    
    dcolor - The new value for the TITLE-DCOLOR attribute.
  - getTitleFgColor
```
public integer getTitleFgColor()
```
    Gets the TITLE-FGCOLOR writable attribute.
    
    Specified by:
    
    getTitleFgColor in interface TitledElement
    
    Returns:
    
    The current value of the TITLE-FGCOLOR attribute.
  - setTitleFgColor
```
public void setTitleFgColor(int64 fgcolor)
```
    Sets the TITLE-FGCOLOR writable attribute.
    
    Specified by:
    
    setTitleFgColor in interface TitledElement
    
    Parameters:
    
    fgcolor - The new value for the TITLE-FGCOLOR attribute.
  - setTitleFgColor
```
public void setTitleFgColor(long fgcolor)
```
    Sets the TITLE-FGCOLOR writable attribute.
    
    Specified by:
    
    setTitleFgColor in interface TitledElement
    
    Parameters:
    
    fgcolor - The new value for the TITLE-FGCOLOR attribute.
  - getTitleFont
```
public integer getTitleFont()
```
    Get the TITLE-FONT attribute of this browse column widget.
    
    Specified by:
    
    getTitleFont in interface CommonWidget
    
    Specified by:
    
    getTitleFont in interface TitledElement
    
    Overrides:
    
    getTitleFont in class GenericWidget<FrameConfig>
    
    Returns:
    
    A value representing an entry in the user's font-table.
  - setTitleFont
```
public void setTitleFont(int64 fontNum)
```
    Set the TITLE-FONT attribute of this browse widget.
    
    Specified by:
    
    setTitleFont in interface CommonWidget
    
    Specified by:
    
    setTitleFont in interface TitledElement
    
    Overrides:
    
    setTitleFont in class GenericWidget<FrameConfig>
    
    Parameters:
    
    fontNum - An entry in the font-table or unknown to refer the default font.
  - setTitleFont
```
public void setTitleFont(long fontNum)
```
    Set the TITLE-FONT attribute of this browse widget.
    
    Specified by:
    
    setTitleFont in interface CommonWidget
    
    Specified by:
    
    setTitleFont in interface TitledElement
    
    Overrides:
    
    setTitleFont in class GenericWidget<FrameConfig>
    
    Parameters:
    
    fontNum - An entry in the font-table or unknown to refer the default font.
  - 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. The FRAME widget specific implementation.
    
    Specified by:
    
    getTabPosition in interface CommonWidget
    
    Overrides:
    
    getTabPosition in class GenericWidget<FrameConfig>
    
    Returns:
    
    The current value of the TAB-POSITION attribute.
  - line
```
public integer line()
```
    Get the current iteration number for down frame.
    
    Specified by:
    
    line in interface FrameInterface
    
    Returns:
    
    The current iteration number.
  - getIteration
```
public handle getIteration(int level)
```
    Implements the GET-ITERATION() widget method.
    
    Specified by:
    
    getIteration in interface IterableResource
    
    Parameters:
    
    level - The level of the iteration to get.
    
    Returns:
    
    The handle of the iteration, field-group or buffer.
  - resolveChainType
```
protected java.lang.String resolveChainType()
```
    Resolve the resource's type, for internal management purposes.
    For DIALOG-BOX and FRAME, FRAME is returned, as these are linked in the same chain.
    
    Overrides:
    
    resolveChainType in class HandleChain
    
    Returns:
    
    the type.
  - resourceDelete
```
protected boolean resourceDelete()
```
    Delete the resource.
    
    Overrides:
    
    resourceDelete in class GenericWidget<FrameConfig>
    
    Returns:
    
    true if the resource was deleted.
  - setInstantiatingProcedure
```
protected void setInstantiatingProcedure(handle hproc)
```
    Set the instantiating procedure for this resource.
    This will set the instantiating procedure only if is not shared or this is the procedure where the frame is registered as shared.
    
    Overrides:
    
    setInstantiatingProcedure in class HandleResource
    
    Parameters:
    
    hproc - The procedure where the resource was instantiated.
  - getValidParentTypes
```
protected java.lang.String[] getValidParentTypes()
```
    Returns the widget types that can act as parent for this widget.
    
    Overrides:
    
    getValidParentTypes in class BaseEntity<FrameConfig>
    
    Returns:
    
    see above.
  - moveToWorker
```
protected boolean moveToWorker(boolean top)
```
    Worker for the GenericWidget.moveToTop() and GenericWidget.moveToBottom() code.
    
    Overrides:
    
    moveToWorker in class GenericWidget<FrameConfig>
    
    Parameters:
    
    top - true if moving to top, false for bottom.
    
    Returns:
    
    true if move succeeded.
  - _setVisible
```
protected void _setVisible(boolean visible)
```
    Sets the frame's config visibility flag.
    
    Overrides:
    
    _setVisible in class GenericWidget<FrameConfig>
    
    Parameters:
    
    visible - The frame's visibility state.
  - _setHidden
```
protected void _setHidden(boolean hidden)
```
    Sets the frame's config hidden flag.
    
    Parameters:
    
    hidden - The frame's hidden state.
  - validateParent
```
protected boolean validateParent(GenericWidget<?> widget)
```
    Checks whether the supplied widget can be used as a valid parent of this widget.
    
    Overrides:
    
    validateParent in class BaseEntity<FrameConfig>
    
    Parameters:
    
    widget - The widget reference to check.
    
    Returns:
    
    true if the supplied widget can be used as a valid parent, false otherwise.
  - validateSize
```
protected boolean validateSize(java.lang.Number value,
                               SizeAttribute attr)
```
    Performs a validation of widget size value.
    
    Overrides:
    
    validateSize in class BaseEntity<FrameConfig>
    
    Parameters:
    
    value - The input value to validate.
    
    attr - Denotes the kind of size attribute.
    
    Returns:
    
    true when valid, false otherwise
  - setSizeChars
```
protected void setSizeChars(java.lang.Double value,
                            SizeAttribute attr)
```
    Sets one of the size char attributes, that is WIDTH-CHARS, HEIGHT-CHARS, MIN-WIDTH-CHARS, MIN-HEIGHT-CHARS, MAX-WIDTH-CHARS, MAX-HEIGHT-CHARS, VIRTUAL-WIDTH_CHARS, VIRTUAL-HEIGHT-CHARS.
    
    Overrides:
    
    setSizeChars in class BaseEntity<FrameConfig>
    
    Parameters:
    
    value - The attribute value. null denotes an unknown attribute value.
    
    attr - The attribute being set.
  - setWidthImpl
```
protected void setWidthImpl(int widthPixels,
                            SizeAttribute attribute)
```
    Implementation for both BaseEntity.setWidthPixels(int) and BaseEntity.setWidthChars(double).
    
    Overrides:
    
    setWidthImpl in class BaseEntity<FrameConfig>
    
    Parameters:
    
    widthPixels - the new widget width in pixels, must be positive
    
    attribute - attribute for reporting purposes
  - setHeightImpl
```
protected void setHeightImpl(int heightPixels,
                             SizeAttribute attribute)
```
    Implementation for both setHeightPixels(int) and setHeightChars(double).
    
    Overrides:
    
    setHeightImpl in class BaseEntity<FrameConfig>
    
    Parameters:
    
    heightPixels - the new widget height in pixels, must be positive
    
    attribute - attribute for reporting purposes
  - setSizePixels
```
protected void setSizePixels(java.lang.Integer value,
                             SizeAttribute attr)
```
    Sets one of the size pixel attributes, that is WIDTH-PIXELS, HEIGHT-PIXELS, MIN-WIDTH-PIXELS, MIN-HEIGHT-PIXELS, MAX-WIDTH-PIXELS, MAX-HEIGHT-PIXELS, VIRTUAL-WIDTH_PIXELS, VIRTUAL-HEIGHT-PIXELS.
    
    Overrides:
    
    setSizePixels in class BaseEntity<FrameConfig>
    
    Parameters:
    
    value - The attribute value. null denotes an unknown attribute value.
    
    attr - The attribute being set.
  - setWidthCharsWorker
```
protected void setWidthCharsWorker(double width)
```
    Sets the value for the attribute WIDTH-CHARS in the associated config instance. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setWidthCharsWorker in class BaseEntity<FrameConfig>
    
    Parameters:
    
    width - Valid width value.
  - setHeightCharsWorker
```
protected void setHeightCharsWorker(double height)
```
    Sets the value for the attribute HEIGHT-CHARS in the associated config instance. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setHeightCharsWorker in class BaseEntity<FrameConfig>
    
    Parameters:
    
    height - Valid height value.
  - setWidthPixelsWorker
```
protected void setWidthPixelsWorker(int width)
```
    Sets the value for the attribute WIDTH-PIXELS in the associated config instance. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setWidthPixelsWorker in class BaseEntity<FrameConfig>
    
    Parameters:
    
    width - Valid width value.
  - setHeightPixelsWorker
```
protected void setHeightPixelsWorker(int height)
```
    Sets the value for the attribute HEIGHT-PIXELS in the associated config instance. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setHeightPixelsWorker in class BaseEntity<FrameConfig>
    
    Parameters:
    
    height - Valid height value.
  - getSizeAttrs
```
protected void getSizeAttrs(java.util.List<java.lang.String> names,
                            java.util.List<java.lang.Object> vals)
```
    Collect the size-related attributes which can be assigned by this widget.
    
    Overrides:
    
    getSizeAttrs in class PaneEntity<FrameConfig>
    
    Parameters:
    
    names - The collection where to add the field names.
    
    vals - The collection where to add the field values.
  - setColumnOrRow
```
protected void setColumnOrRow(boolean isUnknown,
                              double value,
                              boolean row)
```
    Sets the row or column position for this widget.
    
    Overrides:
    
    setColumnOrRow in class BaseEntity<FrameConfig>
    
    Parameters:
    
    isUnknown - If true the attribute value being set is an unknown value.
    
    value - The 1-based row or column number.
    
    row - If true value represents a row number, otherwise a column number.
  - setXorY
```
protected void setXorY(boolean isUnknown,
                       int value,
                       boolean x)
```
    Sets the X or Y position for this widget.
    
    Overrides:
    
    setXorY in class BaseEntity<FrameConfig>
    
    Parameters:
    
    isUnknown - If true the attribute value being set is an unknown value.
    
    value - The X or Y position value.
    
    x - If true value represents an X position, otherwise a Y position.
  - _getHeightChars
```
protected decimal _getHeightChars()
```
    Gets the HEIGHT-CHARS writable attribute.
    
    Overrides:
    
    _getHeightChars in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the HEIGHT-CHARS attribute.
  - _getHeightPixels
```
protected integer _getHeightPixels()
```
    Gets the HEIGHT-PIXELS writable attribute.
    
    Overrides:
    
    _getHeightPixels in class BaseEntity<FrameConfig>
    
    Returns:
    
    The height of the widget in pixels.
  - _getWidthPixels
```
protected integer _getWidthPixels()
```
    Gets the WIDTH-PIXELS writable attribute.
    
    Overrides:
    
    _getWidthPixels in class BaseEntity<FrameConfig>
    
    Returns:
    
    The width of the widget in pixels.
  - _getWidthChars
```
protected decimal _getWidthChars()
```
    Gets the WIDTH-CHARS writable attribute.
    
    Overrides:
    
    _getWidthChars in class BaseEntity<FrameConfig>
    
    Returns:
    
    The current value of the WIDTH-CHARS attribute.
  - getBorderSize
```
private double getBorderSize(boolean chars,
                             boolean row,
                             boolean top)
```
    Get the frame's border size.
    If NO-BOX option is used at a non-dialog frame, then this method returns 0.
    In ChUI, for any kind of frame (dialog, titled, non-titled), it returns 1 for character units and 8 for pixel units, for any border. Note that NO-BOX is ignored for dialog frames.
    In GUI, for non-dialog non-titled frames or left/right/bottom borders for titled frames, the reference is 1 pixel (for any border) which is converted to character units, using the PIXELS-PER-ROW (for top/bottom border) or PIXELS-PER-COlUMN (for left/right border). Note that this border is not dependent on Windows OS appearance settings.
    In GUI, for dialog frames, the left/right/bottom border have a reference of 5 units (these can not be changed in Windows OS).
    Finally, the top border for titled or dialog frames is managed explicitly in borderTopChars() and borderTopPixels().
    
    Parameters:
    
    chars - When true, character units are returned; else, pixel units.
    
    row - When true, it means size for the top/bottom border is returned; else, the size of the left/right border is returned.
    
    top - Flag indicating this is the top border.
    
    Returns:
    
    The border size, in character units.
  - placeFrame
```
private void placeFrame()
```
    Place the frame.
  - resetVirtualSize
```
private void resetVirtualSize(SizeAttribute attr)
```
    Resets the virtual size when the frame is not scrollable and size attributes are assigned.
    
    Parameters:
    
    attr - The information about the attribute being assigned.

Class FrameWidget

Nested Class Summary

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

Field Summary

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

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

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.ui.PaneEntity

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

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

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.util.IterableResource

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

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

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.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

background

Constructor Detail

FrameWidget

FrameWidget

FrameWidget

Method Detail

setId

type

name

name

getPrevSibling

setNextTabItem

getScreenValue

setScreenValueInt

isCarefulPaint

setCarefulPaint

setCarefulPaint

isAttrSpace

setAttrSpace

setAttrSpace

isCentered

setCentered

setCentered

getDefaultButton

setDefaultButton

getCancelButton

setCancelButton

currentIteration

setCurrentIteration

borderTopChars

borderLeftChars

borderRightChars

borderBottomChars

borderTopPixels

borderLeftPixels

borderRightPixels

borderBottomPixels

setDialogBox

isDialogBox

setDown

setDown

getDown

isDown

setHidden

setVisible

getComHandle

hide

view

isSelected

setSelected

setSelected

setSideLabels