WindowWidget (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<WindowConfig>
        
        com.goldencode.p2j.ui.WindowWidget

All Implemented Interfaces:

Checkable, CommonPane, CommonWidget, CommonWindow, ConfigOwner<WindowConfig>, CustomFont, DirectManipulation, DisableRedraw, Droppable, Hoverable, ImageSupport, ImageWidgetSupport, MinHeightCharsInterface, TopOnlyInterface, WriteProtectable, CommonField, CommonHandle, CommonHandleChain, CommonHandleTree, Coordinates, DatabaseInfo, Deletable, DynamicResource, HasVisible, InstantiatingProcedure, Nameable, Sensitive, Sizeable, WrappedResource, Printable
```
public class WindowWidget
extends PaneEntity<WindowConfig>
implements CommonWindow, CommonHandleTree, TopOnlyInterface, Hoverable, MinHeightCharsInterface
```
This class represents the only window widget that exists in a CHUI environment.
The window widget differs from all the other widgets also in this: it is the only widget that is not contained in a frame, but rather contains frames (and other top-level components) itself.

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 MenuWidget menubar
MenuWidget handle owned by this window
- 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 inherited from interface com.goldencode.p2j.ui.CommonWindow
  WINDOW_STATE_DELAYED_MINIMIZE, WINDOW_STATE_MAXIMIZED, WINDOW_STATE_MINIMIZED, WINDOW_STATE_NORMAL

Fields
Modifier and Type	Field and Description
`private MenuWidget`	`menubar` MenuWidget handle owned by this window

Constructor Summary

Constructors
Constructor and Description

WindowWidget(boolean dynamic)
Default constructor.

Constructors
Constructor and Description
`WindowWidget(boolean dynamic)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_setVisible(boolean visible)` Sets the window's config `visibility flag`.
`void`	`afterConfigUpdate(WindowConfig beforeUpdate)` The method is called after the configuration associated with the implementor changes.
`GenericWidget<?>`	`asWidget()` Return reference to `WindowWidget` as reference to `GenericWidget`.
`protected boolean`	`canPushWidgetAttr()` Returns true if the configuration can be pushed to the client-side.
`protected boolean`	`canSetPixelPositionInChui()` The method returns `false` always - windows can't be positioned via pixel in Chui.
`void`	`delete()` Perform actual delete of an resource.
`void`	`detachMenu(MenuWidget menu)` Detach the specified popup-menu or menubar from this widget.
`handle`	`firstChild()` Accesses the first window in the list of contained windows, having this window as parent.
`decimal`	`getFullHeightChars()` Gets the FULL-HEIGHT-CHARS writable attribute.
`integer`	`getFullHeightPixels()` Gets the FULL-HEIGHT-PIXELS writable attribute.
`decimal`	`getFullWidthChars()` Gets the FULL-WIDTH-CHARS writable attribute.
`integer`	`getFullWidthPixels()` Gets the FULL-WIDTH-PIXELS writable attribute.
`character`	`getIcon()` Get icon file name previously loaded by `loadIcon(character)`.
`decimal`	`getMaxHeight()` Get window maximal height.
`decimal`	`getMaxHeightChars()` Gets the MAX-HEIGHT-CHARS writable attribute.
`integer`	`getMaxHeightPixels()` Gets the MAX-HEIGHT-PIXELS writable attribute.
`decimal`	`getMaxWidth()` Get window maximal width.
`decimal`	`getMaxWidthChars()` Gets the MAX-WIDTH-CHARS writable attribute.
`integer`	`getMaxWidthPixels()` Gets the MAX-WIDTH-PIXELS writable attribute.
`handle`	`getMenubar()` Get window MENUBAR.
`int64`	`getMessageAreaFont()` Get the message-area's font.
`decimal`	`getMinHeightChars()` Gets the MIN-HEIGHT-CHARS writable attribute.
`integer`	`getMinHeightPixels()` Gets the MIN-HEIGHT-PIXELS writable attribute.
`decimal`	`getMinWidthChars()` Gets the MIN-WIDTH-CHARS writable attribute.
`integer`	`getMinWidthPixels()` Gets the MIN-WIDTH-PIXELS writable attribute.
`java.lang.String`	`getMousePointerImpl()` Get the MOUSE-POINTER attribute
`handle`	`getNextSibling()` Obtains the next sibling widget in the current field group.
`decimal`	`getScreenLines()` Gets the SCREEN-LINES readable 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.
`int64`	`getStatusAreaFont()` Get the status-area's font.
`protected java.lang.String[]`	`getValidParentTypes()` Returns the widget types that can act as parent for this widget.
`handle`	`getWindow()` Gets the WINDOW attribute.
`integer`	`getWindowHeightPixels()` Returns outer window height, including all decorations.
`int64`	`getWindowState()` Gets the WINDOW-STATE attribute.
`integer`	`getWindowWidthPixels()` Returns outer window width, including all decorations.
`void`	`hide()` For windows, performing a HIDe is the same as setting the VISIBLE attribute to false.
`logical`	`isAlwaysOnTop()` Gets the ALWAYS-ON-TOP attribute's value.
`protected boolean`	`isChained()` Check if this resource can be reported as chained.
`logical`	`isControlBox()` Gets the CONTROL-BOX attribute's value.
`logical`	`isKeepFrameZOrder()` Gets the KEEP-FRAME-Z-ORDER writable attribute.
`logical`	`isKeepZOrder()` Check if window has KEEP-Z-ORDER option set.
`logical`	`isMaxButton()` Gets the MAX-BUTTON attribute.
`logical`	`isMessageArea()` Check if window has message area.
`logical`	`isMinButton()` Gets the MIN-BUTTON attribute.
`logical`	`isScrollBars()` Check if window has scrollbars.
`logical`	`isShowInTaskbar()` Gets the SHOW-IN-TASKBAR attribute.
`logical`	`isSmallTitle()` Gets the SMALL-TITLE attribute's value.
`logical`	`isStatusArea()` Check if window has status area.
`logical`	`isTopOnly()` Gets the TOP-ONLY attribute's value.
`handle`	`lastChild()` Accesses the last window in the list of contained windows, having this window as parent.
`logical`	`loadIcon(character iconPath)` Load icon for window.
`logical`	`loadIcon(java.lang.String searchPath)` Load icon for window.
`private boolean`	`loadIconInt(java.lang.String iconSrc, boolean small)` Load icon for window.
`logical`	`loadSmallIcon(character iconPath)` Load small icon(16x16) for window.
`logical`	`loadSmallIcon(java.lang.String searchPath)` Load small icon(16x16) for window.
`logical`	`moveToBottom()` This method implements MOVE-TO-BOTTOM function.
`logical`	`moveToTop()` This method implements MOVE-TO-TOP function.
`protected void`	`pushScreenDefinition()` Push this window definition.
`protected void`	`pushSizeAttrs()` Push all the size-related attributes to the client-size.
`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 changes to the client-side.
`protected boolean`	`resourceDelete()` Delete the resource.
`void`	`setAlwaysOnTop(boolean value)` Sets the ALWAYS-ON-TOP attribute.
`void`	`setBgColor()` Set (default) background color.
`void`	`setControlBox(boolean value)` Sets the CONTROL-BOX attribute.
`void`	`setFgColor()` Set (default) foreground color.
`protected void`	`setHeightCharsWorker(double height)` Sets the value for the attribute HEIGHT-CHARS in the associated config instance.
`protected void`	`setHeightPixelsWorker(int height)` Sets the value for the attribute HEIGHT-PIXELS in the associated config instance.
`void`	`setHidden(boolean hidden)` Sets the HIDDEN writable attribute.
`void`	`setKeepFrameZOrder(boolean keep)` Sets the KEEP-FRAME-Z-ORDER writable attribute.
`void`	`setKeepFrameZOrder(logical keep)` Sets the KEEP-FRAME-Z-ORDER writable attribute.
`void`	`setKeepZOrder(logical keepFrameZOrder)` Enable/disable KEEP-Z-ORDER option.
`void`	`setMaxButton(boolean value)` Sets the MAX-BUTTON attribute.
`void`	`setMaxHeight(NumberType maxHeight)` Set maximal height.
`void`	`setMaxHeightChars(double max)` Sets the MAX-HEIGHT-CHARS writable attribute.
`void`	`setMaxHeightChars(NumberType max)` Sets the MAX-HEIGHT-CHARS writable attribute.
`protected void`	`setMaxHeightCharsWorker(double height)` Sets the value for the attribute MAX-HEIGHT-CHARS.
`void`	`setMaxHeightPixels(integer max)` Sets the MAX-HEIGHT-PIXELS writable attribute.
`protected void`	`setMaxHeightPixelsWorker(int height)` Sets the value for the attribute MAX-HEIGHT-PIXELS.
`void`	`setMaxWidth(NumberType maxWidth)` Set maximal width.
`void`	`setMaxWidthChars(double max)` Sets the MAX-WIDTH-CHARS writable attribute.
`void`	`setMaxWidthChars(NumberType max)` Sets the MAX-WIDTH-CHARS writable attribute.
`protected void`	`setMaxWidthCharsWorker(double width)` Sets the value for the attribute MAX-WIDTH-CHARS.
`void`	`setMaxWidthPixels(integer max)` Sets the MAX-WIDTH-PIXELS writable attribute.
`protected void`	`setMaxWidthPixelsWorker(int width)` Sets the value for the attribute MAX-WIDTH-PIXELS.
`void`	`setMenubar(handle menubar)` Set window MENUBAR.
`void`	`setMenubar(MenuWidget menubar)` Set window MENUBAR.
`void`	`setMessageArea(logical messageArea)` Enable/disable displaying of message area.
`void`	`setMessageAreaFont(int64 fontNum)` Set the message-area's font.
`void`	`setMessageAreaFont(long fontNum)` Set the message-area's font.
`void`	`setMinButton(boolean value)` Sets the MIN-BUTTON attribute.
`void`	`setMinHeightChars(NumberType min)` Sets the MIN-HEIGHT-CHARS writable attribute.
`protected void`	`setMinHeightCharsWorker(double height)` Sets the value for the attribute MIN-HEIGHT-CHARS.
`void`	`setMinHeightPixels(integer min)` Sets the MIN-HEIGHT-PIXELS writable attribute.
`protected void`	`setMinHeightPixelsWorker(int height)` Sets the value for the attribute MIN-HEIGHT-PIXELS.
`void`	`setMinWidthChars(NumberType min)` Sets the MIN-WIDTH-CHARS writable attribute.
`protected void`	`setMinWidthCharsWorker(double width)` Sets the value for the attribute MIN-WIDTH-CHARS.
`void`	`setMinWidthPixels(integer min)` Sets the MIN-WIDTH-CHARS writable attribute.
`protected void`	`setMinWidthPixelsWorker(int width)` Sets the value for the attribute MIN-WIDTH-PIXELS.
`void`	`setMousePointerName(java.lang.String name)` Set the MOUSE-POINTER attribute
`void`	`setScrollBars(logical scrollBars)` Enable/disable displaying of scrollbars.
`void`	`setSensitive(boolean s)` Sets new value of SENSITIVE attribute.
`void`	`setShowInTaskbar(boolean value)` Sets the SHOW-IN-TASKBAR attribute.
`void`	`setSmallTitle(boolean value)` Sets the SMALL-TITLE attribute.
`void`	`setStatusArea(logical statusArea)` Enable/disable displaying of status area.
`void`	`setStatusAreaFont(int64 fontNum)` Set the status-area's font.
`void`	`setStatusAreaFont(long fontNum)` Set the status-area's font.
`void`	`setTitle(java.lang.String title)` Sets the TITLE writable attribute and pushes the config to the client-side.
`void`	`setTopOnly(boolean topOnly)` Sets the TOP-ONLY option/attribute.
`void`	`setTopOnly(logical topOnly)` Sets the TOP-ONLY option/attribute.
`protected void`	`setVirtHeightCharsWorker(double height)` Sets the value for the attribute VIRTUAL-HEIGHT-CHARS.
`protected void`	`setVirtHeightPixelsWorker(int height)` Sets the value for the attribute VIRTUAL-HEIGHT-PIXELS.
`protected void`	`setVirtWidthCharsWorker(double width)` Sets the value for the attribute VIRTUAL-WIDTH-CHARS.
`protected void`	`setVirtWidthPixelsWorker(int width)` Sets the value for the attribute VIRTUAL-WIDTH-PIXELS.
`void`	`setVisible(boolean visible)` Set the VISIBLE writable attribute.
`protected void`	`setWidthCharsWorker(double width)` Sets the value for the attribute WIDTH-CHARS in the associated config instance.
`protected void`	`setWidthPixelsWorker(int width)` Sets the value for the attribute WIDTH-PIXELS in the associated config instance.
`void`	`setWindowState(int64 state)` Sets the WINDOW-STATE attribute.
`void`	`setWindowState(long state)` Sets the WINDOW-STATE 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.
`private void`	`updateMinMaxSize()` The method updates min/max size config fields and should be called after window size is changed.
`protected boolean`	`useHandleChainSiblings()` Indicates an implementation of siblings methods.
`boolean`	`valid()` Reports if this widget object is valid for use.
`protected boolean`	`validateSize(java.lang.Number value, SizeAttribute attr)` Performs a validation of widget size value.
`void`	`view()` For windows, performing a VIEW is the same as setting the VISIBLE attribute to true.

Methods inherited from class com.goldencode.p2j.ui.BaseEntity
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, changeFontWorker, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColor, getBgColorRgb, getColumn, getDColor, getFgColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getParent, getParent, getPfColor, getPrevSibling, getRow, getTitle, getTooltip, getWidthChars, getWidthPixels, getX, getY, isFontBold, isFontItalic, isFontUnderline, isMovable, isResizable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFgColorRgb, setFgColorRgb, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightImpl, setHeightPixels, setHeightPixels, setMovable, setMovable, setParent, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTitle, setTooltip, setTooltip, setWidthChars, setWidthChars, setWidthImpl, setWidthPixels, setWidthPixels, setX, setX, setXorY, setXOrYWorker, setY, setY, validateParent, 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, cleanup, colorDisplay, colorPrompt, config, deselectRows, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFormat, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabel, getLabelFont, getLabelStr, getLogicalTerminal, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getWidgetId, getWidth, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, implicitDeletion, inputValue, isAutoCompletion, isAutoResize, isAutoReturn, isChecked, isDisableRedraw, isEntered, isExpandLabel, isFocusedRowSelected, isHidden, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isScrollable, 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, moveToWorker, name, notQueryable, notQueryable, notSettable, notSettable, notWorker, openPopup, preRealizeCheck, processSideLabel, 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, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setFromOCX, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setId, setLabel, setLabel, setLabel, setLabelFont, setLabelFont, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setModified, setModified, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValue, setScreenValue, setScreenValueInt, setScreenValueNoErrorHandling, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVisible, setWidgetId, setWidgetId, setWidth, type, underline, underline, validate, validateFields, 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, 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.CommonWindow
isResize, setAlwaysOnTop, setControlBox, setMaxButton, setMinButton, setResize, setShowInTaskbar, setSmallTitle

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.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
  - menubar
```
private MenuWidget menubar
```
    MenuWidget handle owned by this window
- Constructor Detail
  - WindowWidget
```
WindowWidget(boolean dynamic)
```
    Default constructor. It is package private because an instance must only be created in a controllable way.
    
    Parameters:
    
    dynamic - Flag indicating if this is a static or dynamic resource.
- Method Detail
  - valid
```
public boolean valid()
```
    Reports if this widget object is valid for use.
    
    Specified by:
    
    valid in interface CommonWidget
    
    Specified by:
    
    valid in interface WrappedResource
    
    Overrides:
    
    valid in class GenericWidget<WindowConfig>
    
    Returns:
    
    The state of the GenericWidget.deleted flag.
  - isKeepFrameZOrder
```
public logical isKeepFrameZOrder()
```
    Gets the KEEP-FRAME-Z-ORDER writable attribute.
    
    Specified by:
    
    isKeepFrameZOrder in interface CommonWidget
    
    Specified by:
    
    isKeepFrameZOrder in interface CommonWindow
    
    Overrides:
    
    isKeepFrameZOrder in class GenericWidget<WindowConfig>
    
    Returns:
    
    The current value of the KEEP-FRAME-Z-ORDER attribute.
  - setKeepFrameZOrder
```
public void setKeepFrameZOrder(logical keep)
```
    Sets the KEEP-FRAME-Z-ORDER writable attribute.
    
    Specified by:
    
    setKeepFrameZOrder in interface CommonWidget
    
    Specified by:
    
    setKeepFrameZOrder in interface CommonWindow
    
    Overrides:
    
    setKeepFrameZOrder in class GenericWidget<WindowConfig>
    
    Parameters:
    
    keep - The new value for the KEEP-FRAME-Z-ORDER attribute.
  - setKeepFrameZOrder
```
public void setKeepFrameZOrder(boolean keep)
```
    Sets the KEEP-FRAME-Z-ORDER writable attribute.
    
    Specified by:
    
    setKeepFrameZOrder in interface CommonWidget
    
    Specified by:
    
    setKeepFrameZOrder in interface CommonWindow
    
    Overrides:
    
    setKeepFrameZOrder in class GenericWidget<WindowConfig>
    
    Parameters:
    
    keep - The new value for the KEEP-FRAME-Z-ORDER attribute.
  - getFullHeightChars
```
public decimal getFullHeightChars()
```
    Gets the FULL-HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    getFullHeightChars in interface CommonWindow
    
    Returns:
    
    current value of FULL-HEIGHT-CHARS attribute
  - getFullHeightPixels
```
public integer getFullHeightPixels()
```
    Gets the FULL-HEIGHT-PIXELS writable attribute.
    
    Specified by:
    
    getFullHeightPixels in interface CommonWindow
    
    Returns:
    
    current value of FULL-HEIGHT-PIXELS attribute
  - getFullWidthChars
```
public decimal getFullWidthChars()
```
    Gets the FULL-WIDTH-CHARS writable attribute.
    
    Specified by:
    
    getFullWidthChars in interface CommonWindow
    
    Returns:
    
    current value of FULL-WIDTH-CHARS attribute
  - getFullWidthPixels
```
public integer getFullWidthPixels()
```
    Gets the FULL-WIDTH-PIXELS writable attribute.
    
    Specified by:
    
    getFullWidthPixels in interface CommonWindow
    
    Returns:
    
    current value of FULL-WIDTH-PIXELS attribute
  - getMaxHeightChars
```
public decimal getMaxHeightChars()
```
    Gets the MAX-HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    getMaxHeightChars in interface CommonWidget
    
    Specified by:
    
    getMaxHeightChars in interface CommonWindow
    
    Overrides:
    
    getMaxHeightChars in class GenericWidget<WindowConfig>
    
    Returns:
    
    current value of MAX-HEIGHT-CHARS attribute
  - setMaxHeightChars
```
public void setMaxHeightChars(NumberType max)
```
    Sets the MAX-HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    setMaxHeightChars in interface CommonWindow
    
    Parameters:
    
    max - The new value for the MAX-HEIGHT-CHARS attribute.
  - setMaxHeightChars
```
public void setMaxHeightChars(double max)
```
    Sets the MAX-HEIGHT-CHARS writable attribute.
    
    Parameters:
    
    max - The new value for the MAX-HEIGHT-CHARS attribute.
  - getMaxWidthChars
```
public decimal getMaxWidthChars()
```
    Gets the MAX-WIDTH-CHARS writable attribute.
    
    Specified by:
    
    getMaxWidthChars in interface CommonWidget
    
    Specified by:
    
    getMaxWidthChars in interface CommonWindow
    
    Overrides:
    
    getMaxWidthChars in class GenericWidget<WindowConfig>
    
    Returns:
    
    The current value of MAX-WIDTH-CHARS attribute.
  - setMaxWidthChars
```
public void setMaxWidthChars(NumberType max)
```
    Sets the MAX-WIDTH-CHARS writable attribute.
    
    Specified by:
    
    setMaxWidthChars in interface CommonWindow
    
    Parameters:
    
    max - The new value for the MAX-WIDTH-CHARS attribute.
  - setMaxWidthChars
```
public void setMaxWidthChars(double max)
```
    Sets the MAX-WIDTH-CHARS writable attribute.
    
    Parameters:
    
    max - The new value for the MAX-WIDTH-CHARS attribute.
  - setMaxHeight
```
public void setMaxHeight(NumberType maxHeight)
```
    Set maximal height.
    
    Specified by:
    
    setMaxHeight in interface CommonWindow
    
    Parameters:
    
    maxHeight - New option value.
  - setMaxWidth
```
public void setMaxWidth(NumberType maxWidth)
```
    Set maximal width.
    
    Specified by:
    
    setMaxWidth in interface CommonWindow
    
    Parameters:
    
    maxWidth - New option value.
  - getMinHeightChars
```
public decimal getMinHeightChars()
```
    Gets the MIN-HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    getMinHeightChars in interface MinHeightCharsInterface
    
    Returns:
    
    current value of MIN-HEIGHT-CHARS attribute
  - getMinWidthChars
```
public decimal getMinWidthChars()
```
    Gets the MIN-WIDTH-CHARS writable attribute.
    
    Specified by:
    
    getMinWidthChars in interface CommonWindow
    
    Returns:
    
    current value of MIN-WIDTH-CHARS attribute
  - setMinHeightChars
```
public void setMinHeightChars(NumberType min)
```
    Sets the MIN-HEIGHT-CHARS writable attribute.
    
    Specified by:
    
    setMinHeightChars in interface MinHeightCharsInterface
    
    Parameters:
    
    min - The new value for the MIN-HEIGHT-CHARS attribute.
  - setMinWidthChars
```
public void setMinWidthChars(NumberType min)
```
    Sets the MIN-WIDTH-CHARS writable attribute.
    
    Specified by:
    
    setMinWidthChars in interface CommonWindow
    
    Parameters:
    
    min - The new value for the MIN-WIDTH-CHARS attribute.
  - getMinHeightPixels
```
public integer getMinHeightPixels()
```
    Gets the MIN-HEIGHT-PIXELS writable attribute.
    
    Specified by:
    
    getMinHeightPixels in interface CommonWindow
    
    Returns:
    
    current value of MIN-HEIGHT-PIXELS attribute
  - getMinWidthPixels
```
public integer getMinWidthPixels()
```
    Gets the MIN-WIDTH-PIXELS writable attribute.
    
    Specified by:
    
    getMinWidthPixels in interface CommonWindow
    
    Returns:
    
    current value of MIN-WIDTH-PIXELS attribute
  - setMinHeightPixels
```
public void setMinHeightPixels(integer min)
```
    Sets the MIN-HEIGHT-PIXELS writable attribute.
    
    Specified by:
    
    setMinHeightPixels in interface CommonWindow
    
    Parameters:
    
    min - The new value for the MIN-HEIGHT-PIXELS attribute.
  - setMinWidthPixels
```
public void setMinWidthPixels(integer min)
```
    Sets the MIN-WIDTH-CHARS writable attribute.
    
    Specified by:
    
    setMinWidthPixels in interface CommonWindow
    
    Parameters:
    
    min - The new value for the MIN-WIDTH-CHARS attribute.
  - setScrollBars
```
public void setScrollBars(logical scrollBars)
```
    Enable/disable displaying of scrollbars.
    
    Specified by:
    
    setScrollBars in interface CommonWindow
    
    Parameters:
    
    scrollBars - New option value.
  - setStatusArea
```
public void setStatusArea(logical statusArea)
```
    Enable/disable displaying of status area.
    
    Specified by:
    
    setStatusArea in interface CommonWindow
    
    Parameters:
    
    statusArea - New option value.
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Sets the TITLE writable attribute and pushes the config to the client-side.
    
    Specified by:
    
    setTitle in interface CommonWidget
    
    Overrides:
    
    setTitle in class BaseEntity<WindowConfig>
    
    Parameters:
    
    title - The new value for the TITLE attribute.
  - setSensitive
```
public void setSensitive(boolean s)
```
    Sets new value of SENSITIVE attribute.
    
    Specified by:
    
    setSensitive in interface Sensitive
    
    Overrides:
    
    setSensitive in class GenericWidget<WindowConfig>
    
    Parameters:
    
    s - new value of SENSITIVE attribute
  - setBgColor
```
public void setBgColor()
```
    Set (default) background color.
  - setFgColor
```
public void setFgColor()
```
    Set (default) foreground color.
  - setKeepZOrder
```
public void setKeepZOrder(logical keepFrameZOrder)
```
    Enable/disable KEEP-Z-ORDER option.
    
    Specified by:
    
    setKeepZOrder in interface CommonWindow
    
    Parameters:
    
    keepFrameZOrder - New flag value.
  - setMessageArea
```
public void setMessageArea(logical messageArea)
```
    Enable/disable displaying of message area.
    
    Specified by:
    
    setMessageArea in interface CommonWindow
    
    Parameters:
    
    messageArea - New flag value.
  - getMaxHeight
```
public decimal getMaxHeight()
```
    Get window maximal height.
    
    Specified by:
    
    getMaxHeight in interface CommonWindow
    
    Returns:
    
    maximal height.
  - getMaxWidth
```
public decimal getMaxWidth()
```
    Get window maximal width.
    
    Specified by:
    
    getMaxWidth in interface CommonWindow
    
    Returns:
    
    maximal width.
  - isScrollBars
```
public logical isScrollBars()
```
    Check if window has scrollbars.
    
    Specified by:
    
    isScrollBars in interface CommonWindow
    
    Returns:
    
    true if window has scrollbars.
  - isStatusArea
```
public logical isStatusArea()
```
    Check if window has status area.
    
    Specified by:
    
    isStatusArea in interface CommonWindow
    
    Returns:
    
    true if window has status area.
  - isKeepZOrder
```
public logical isKeepZOrder()
```
    Check if window has KEEP-Z-ORDER option set.
    
    Specified by:
    
    isKeepZOrder in interface CommonWindow
    
    Returns:
    
    true if window has KEEP-Z-ORDER option set.
  - isMessageArea
```
public logical isMessageArea()
```
    Check if window has message area.
    
    Specified by:
    
    isMessageArea in interface CommonWindow
    
    Returns:
    
    true if window has message area.
  - getIcon
```
public character getIcon()
```
    Get icon file name previously loaded by loadIcon(character).
    
    Specified by:
    
    getIcon in interface CommonWindow
    
    Returns:
    
    icon file name.
  - loadIcon
```
public logical loadIcon(character iconPath)
```
    Load icon for window.
    
    Specified by:
    
    loadIcon in interface CommonWindow
    
    Parameters:
    
    iconPath - Icon file name.
    
    Returns:
    
    true if operation was successful.
  - loadIcon
```
public logical loadIcon(java.lang.String searchPath)
```
    Load icon for window.
    
    Specified by:
    
    loadIcon in interface CommonWindow
    
    Parameters:
    
    searchPath - Icon file name.
    
    Returns:
    
    true if operation was successful.
  - loadSmallIcon
```
public logical loadSmallIcon(character iconPath)
```
    Load small icon(16x16) for window.
    
    Specified by:
    
    loadSmallIcon in interface CommonWindow
    
    Parameters:
    
    iconPath - Icon file name.
    
    Returns:
    
    true if operation was successful.
  - loadSmallIcon
```
public logical loadSmallIcon(java.lang.String searchPath)
```
    Load small icon(16x16) for window.
    
    Specified by:
    
    loadSmallIcon in interface CommonWindow
    
    Parameters:
    
    searchPath - Icon file name.
    
    Returns:
    
    true if operation was successful.
  - asWidget
```
public GenericWidget<?> asWidget()
```
    Return reference to WindowWidget as reference to GenericWidget.
    
    Returns:
    
    this.
  - setMaxHeightPixels
```
public void setMaxHeightPixels(integer max)
```
    Sets the MAX-HEIGHT-PIXELS writable attribute.
    
    Specified by:
    
    setMaxHeightPixels in interface CommonWindow
    
    Parameters:
    
    max - The new value for the MAX-HEIGHT-PIXELS attribute.
  - setMaxWidthPixels
```
public void setMaxWidthPixels(integer max)
```
    Sets the MAX-WIDTH-PIXELS writable attribute.
    
    Specified by:
    
    setMaxWidthPixels in interface CommonWindow
    
    Parameters:
    
    max - The new value for the MAX-WIDTH-PIXELS attribute.
  - getMaxHeightPixels
```
public integer getMaxHeightPixels()
```
    Gets the MAX-HEIGHT-PIXELS writable attribute.
    
    Specified by:
    
    getMaxHeightPixels in interface CommonWindow
    
    Returns:
    
    current value of MAX-HEIGHT-PIXELS attribute
  - getMaxWidthPixels
```
public integer getMaxWidthPixels()
```
    Gets the MAX-WIDTH-PIXELS writable attribute.
    
    Specified by:
    
    getMaxWidthPixels in interface CommonWindow
    
    Returns:
    
    current value of MAX-WIDT-PIXELS attribute
  - getMessageAreaFont
```
public int64 getMessageAreaFont()
```
    Get the message-area's font.
    
    Specified by:
    
    getMessageAreaFont in interface CommonWindow
    
    Returns:
    
    The message-area's font.
  - setMessageAreaFont
```
public void setMessageAreaFont(long fontNum)
```
    Set the message-area's font.
    
    Specified by:
    
    setMessageAreaFont in interface CommonWindow
    
    Parameters:
    
    fontNum - The font number, an entry in the font-table.
  - setMessageAreaFont
```
public void setMessageAreaFont(int64 fontNum)
```
    Set the message-area's font.
    
    Specified by:
    
    setMessageAreaFont in interface CommonWindow
    
    Parameters:
    
    fontNum - The font number, an entry in the font-table.
  - getStatusAreaFont
```
public int64 getStatusAreaFont()
```
    Get the status-area's font.
    
    Specified by:
    
    getStatusAreaFont in interface CommonWindow
    
    Returns:
    
    The status-area's font.
  - setStatusAreaFont
```
public void setStatusAreaFont(long fontNum)
```
    Set the status-area's font.
    
    Specified by:
    
    setStatusAreaFont in interface CommonWindow
    
    Parameters:
    
    fontNum - The font number, an entry in the font-table.
  - setStatusAreaFont
```
public void setStatusAreaFont(int64 fontNum)
```
    Set the status-area's font.
    
    Specified by:
    
    setStatusAreaFont in interface CommonWindow
    
    Parameters:
    
    fontNum - The font number, an entry in the font-table.
  - 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<WindowConfig>
    
    Returns:
    
    The value as a character type or the empty string if the screen buffer value is uninitialized.
  - resourceDelete
```
protected boolean resourceDelete()
```
    Delete the resource.
    
    Overrides:
    
    resourceDelete in class GenericWidget<WindowConfig>
    
    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).
    All the direct child windows will be deleted too; and recursively, the entire window tree will be deleted.
    
    Specified by:
    
    delete in interface Deletable
    
    Overrides:
    
    delete in class GenericWidget<WindowConfig>
  - 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
  - validateSize
```
protected boolean validateSize(java.lang.Number value,
                               SizeAttribute attr)
```
    Description copied from class: BaseEntity
    
    Performs a validation of widget size value.
    
    Overrides:
    
    validateSize in class BaseEntity<WindowConfig>
    
    Parameters:
    
    value - The input value to validate.
    
    attr - Denotes the kind of size attribute.
    
    Returns:
    
    true when valid, false otherwise
  - 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<WindowConfig>
    
    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<WindowConfig>
    
    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<WindowConfig>
    
    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<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setMinWidthCharsWorker
```
protected void setMinWidthCharsWorker(double width)
```
    Sets the value for the attribute MIN-WIDTH-CHARS. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setMinWidthCharsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    width - Valid width value.
  - setMinHeightCharsWorker
```
protected void setMinHeightCharsWorker(double height)
```
    Sets the value for the attribute MIN-HEIGHT-CHARS. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setMinHeightCharsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setMinWidthPixelsWorker
```
protected void setMinWidthPixelsWorker(int width)
```
    Sets the value for the attribute MIN-WIDTH-PIXELS. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setMinWidthPixelsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    width - Valid width value.
  - setMinHeightPixelsWorker
```
protected void setMinHeightPixelsWorker(int height)
```
    Sets the value for the attribute MIN-HEIGHT-PIXELS. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setMinHeightPixelsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setMaxWidthCharsWorker
```
protected void setMaxWidthCharsWorker(double width)
```
    Sets the value for the attribute MAX-WIDTH-CHARS. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setMaxWidthCharsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    width - Valid width value.
  - setMaxHeightCharsWorker
```
protected void setMaxHeightCharsWorker(double height)
```
    Sets the value for the attribute MAX-HEIGHT-CHARS. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setMaxHeightCharsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setMaxWidthPixelsWorker
```
protected void setMaxWidthPixelsWorker(int width)
```
    Sets the value for the attribute MAX-WIDTH-PIXELS. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setMaxWidthPixelsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    width - Valid width value.
  - setMaxHeightPixelsWorker
```
protected void setMaxHeightPixelsWorker(int height)
```
    Sets the value for the attribute MAX-HEIGHT-PIXELS. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setMaxHeightPixelsWorker in class BaseEntity<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setVirtWidthCharsWorker
```
protected void setVirtWidthCharsWorker(double width)
```
    Sets the value for the attribute VIRTUAL-WIDTH-CHARS. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setVirtWidthCharsWorker in class PaneEntity<WindowConfig>
    
    Parameters:
    
    width - Valid width value.
  - setVirtHeightCharsWorker
```
protected void setVirtHeightCharsWorker(double height)
```
    Sets the value for the attribute VIRTUAL-HEIGHT-CHARS. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setVirtHeightCharsWorker in class PaneEntity<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setVirtWidthPixelsWorker
```
protected void setVirtWidthPixelsWorker(int width)
```
    Sets the value for the attribute VIRTUAL-WIDTH-PIXELS. Only valid width values must be passed in the width argument.
    
    Overrides:
    
    setVirtWidthPixelsWorker in class PaneEntity<WindowConfig>
    
    Parameters:
    
    width - Valid width value.
  - setVirtHeightPixelsWorker
```
protected void setVirtHeightPixelsWorker(int height)
```
    Sets the value for the attribute VIRTUAL-HEIGHT-PIXELS. Only valid height values must be passed in the height argument.
    
    Overrides:
    
    setVirtHeightPixelsWorker in class PaneEntity<WindowConfig>
    
    Parameters:
    
    height - Valid height value.
  - setVisible
```
public void setVisible(boolean visible)
```
    Set the VISIBLE writable attribute.
    
    Specified by:
    
    setVisible in interface HasVisible
    
    Overrides:
    
    setVisible in class GenericWidget<WindowConfig>
    
    Parameters:
    
    visible - The new value for the VISIBLE attribute.
  - getMenubar
```
public handle getMenubar()
```
    Get window MENUBAR.
    
    Specified by:
    
    getMenubar in interface CommonWindow
    
    Returns:
    
    handle.
  - setMenubar
```
public void setMenubar(handle menubar)
```
    Set window MENUBAR.
    
    Specified by:
    
    setMenubar in interface CommonWindow
    
    Parameters:
    
    menubar - The menu bar handle.
  - setMenubar
```
public void setMenubar(MenuWidget menubar)
```
    Set window MENUBAR.
    
    Specified by:
    
    setMenubar in interface CommonWindow
    
    Parameters:
    
    menubar - The menu widget.
  - detachMenu
```
public void detachMenu(MenuWidget menu)
```
    Detach the specified popup-menu or menubar from this widget.
    
    Overrides:
    
    detachMenu in class GenericWidget<WindowConfig>
    
    Parameters:
    
    menu - The menu to detach.
  - getScreenLines
```
public decimal getScreenLines()
```
    Gets the SCREEN-LINES readable attribute.
    
    Specified by:
    
    getScreenLines in interface CommonWindow
    
    Returns:
    
    current value of SCREEN-LINES attribute
  - view
```
public void view()
```
    For windows, performing a VIEW is the same as setting the VISIBLE attribute to true.
    
    Specified by:
    
    view in interface CommonWidget
    
    Overrides:
    
    view in class GenericWidget<WindowConfig>
  - hide
```
public void hide()
```
    For windows, performing a HIDe is the same as setting the VISIBLE attribute to false.
    
    Specified by:
    
    hide in interface CommonWidget
    
    Overrides:
    
    hide in class GenericWidget<WindowConfig>
  - getNextSibling
```
public handle getNextSibling()
```
    Obtains the next sibling widget in the current field group.
    
    Specified by:
    
    getNextSibling in interface CommonHandleChain
    
    Overrides:
    
    getNextSibling in class BaseEntity<WindowConfig>
    
    Returns:
    
    The next sibling or an unknown handle if this is the only widget or if this is the last widget.
  - firstChild
```
public handle firstChild()
```
    Accesses the first window in the list of contained windows, having this window as parent.
    
    Specified by:
    
    firstChild in interface CommonHandleTree
    
    Returns:
    
    The first widget or null if no widgets are contained.
  - lastChild
```
public handle lastChild()
```
    Accesses the last window in the list of contained windows, having this window as parent.
    
    Specified by:
    
    lastChild in interface CommonHandleTree
    
    Returns:
    
    The last widget or null if no widgets are contained.
  - moveToTop
```
public logical moveToTop()
```
    This method implements MOVE-TO-TOP function.
    
    Specified by:
    
    moveToTop in interface CommonWidget
    
    Overrides:
    
    moveToTop in class GenericWidget<WindowConfig>
    
    Returns:
    
    true if operation was successful.
  - moveToBottom
```
public logical moveToBottom()
```
    This method implements MOVE-TO-BOTTOM function.
    
    Specified by:
    
    moveToBottom in interface CommonWidget
    
    Overrides:
    
    moveToBottom in class GenericWidget<WindowConfig>
    
    Returns:
    
    true if operation was successful.
  - 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
  - setAlwaysOnTop
```
public void setAlwaysOnTop(boolean value)
```
    Sets the ALWAYS-ON-TOP attribute.
    
    Specified by:
    
    setAlwaysOnTop in interface CommonWindow
    
    Parameters:
    
    value - true if the option/attribute is set to ON.
  - isAlwaysOnTop
```
public logical isAlwaysOnTop()
```
    Gets the ALWAYS-ON-TOP attribute's value.
    
    Specified by:
    
    isAlwaysOnTop in interface CommonWindow
    
    Returns:
    
    the value of the attribute
  - setControlBox
```
public void setControlBox(boolean value)
```
    Sets the CONTROL-BOX attribute.
    
    Specified by:
    
    setControlBox in interface CommonWindow
    
    Parameters:
    
    value - true if the option/attribute is set to ON.
  - isControlBox
```
public logical isControlBox()
```
    Gets the CONTROL-BOX attribute's value.
    
    Specified by:
    
    isControlBox in interface CommonWindow
    
    Returns:
    
    the value of the attribute
  - setSmallTitle
```
public void setSmallTitle(boolean value)
```
    Sets the SMALL-TITLE attribute.
    
    Specified by:
    
    setSmallTitle in interface CommonWindow
    
    Parameters:
    
    value - true if the option/attribute is set to ON.
  - isSmallTitle
```
public logical isSmallTitle()
```
    Gets the SMALL-TITLE attribute's value.
    
    Specified by:
    
    isSmallTitle in interface CommonWindow
    
    Returns:
    
    the value of the attribute
  - getWindowState
```
public int64 getWindowState()
```
    Gets the WINDOW-STATE attribute.
    
    Specified by:
    
    getWindowState in interface CommonWindow
    
    Returns:
    
    current value of WINDOW-STATE attribute (see WINDOW_STATE_* constants).
  - setWindowState
```
public void setWindowState(long state)
```
    Sets the WINDOW-STATE attribute.
    
    Specified by:
    
    setWindowState in interface CommonWindow
    
    Parameters:
    
    state - Value of WINDOW-STATE attribute to set (see WINDOW_STATE_* constants).
  - setWindowState
```
public void setWindowState(int64 state)
```
    Sets the WINDOW-STATE attribute.
    
    Specified by:
    
    setWindowState in interface CommonWindow
    
    Parameters:
    
    state - Value of WINDOW-STATE attribute to set (see WINDOW_STATE_* constants).
  - setMinButton
```
public void setMinButton(boolean value)
```
    Sets the MIN-BUTTON attribute.
    
    Specified by:
    
    setMinButton in interface CommonWindow
    
    Parameters:
    
    value - The new attribute value.
  - isMinButton
```
public logical isMinButton()
```
    Gets the MIN-BUTTON attribute.
    
    Specified by:
    
    isMinButton in interface CommonWindow
    
    Returns:
    
    see above.
  - setMaxButton
```
public void setMaxButton(boolean value)
```
    Sets the MAX-BUTTON attribute.
    
    Specified by:
    
    setMaxButton in interface CommonWindow
    
    Parameters:
    
    value - The new attribute value.
  - isMaxButton
```
public logical isMaxButton()
```
    Gets the MAX-BUTTON attribute.
    
    Specified by:
    
    isMaxButton in interface CommonWindow
    
    Returns:
    
    see above.
  - setShowInTaskbar
```
public void setShowInTaskbar(boolean value)
```
    Sets the SHOW-IN-TASKBAR attribute.
    
    Specified by:
    
    setShowInTaskbar in interface CommonWindow
    
    Parameters:
    
    value - The new attribute value.
  - isShowInTaskbar
```
public logical isShowInTaskbar()
```
    Gets the SHOW-IN-TASKBAR attribute.
    
    Specified by:
    
    isShowInTaskbar in interface CommonWindow
    
    Returns:
    
    see above.
  - setHidden
```
public void setHidden(boolean hidden)
```
    Sets the HIDDEN writable attribute.
    
    Specified by:
    
    setHidden in interface CommonWidget
    
    Overrides:
    
    setHidden in class GenericWidget<WindowConfig>
    
    Parameters:
    
    hidden - The new value for the HIDDEN attribute.
  - getWindow
```
public handle getWindow()
```
    Gets the WINDOW attribute.
    
    Specified by:
    
    getWindow in interface CommonWidget
    
    Overrides:
    
    getWindow in class GenericWidget<WindowConfig>
    
    Returns:
    
    the value of the attribute
  - getWindowWidthPixels
```
public integer getWindowWidthPixels()
```
    Returns outer window width, including all decorations.
    
    Returns:
    
    see above.
  - getWindowHeightPixels
```
public integer getWindowHeightPixels()
```
    Returns outer window height, including all decorations.
    
    Returns:
    
    see above.
  - pushWidgetAttr
```
public void pushWidgetAttr(java.lang.String fname,
                           java.lang.Object value)
```
    Push the specified widget attribute changes to the client-side.
    This just invokes LogicalTerminal.pushWindow(com.goldencode.p2j.ui.WindowConfig).
    
    Overrides:
    
    pushWidgetAttr in class GenericWidget<WindowConfig>
    
    Parameters:
    
    fname - The list of config field names.
    
    value - The list of new config field values.
  - pushWidgetAttr
```
public void pushWidgetAttr(java.lang.String[] fnames,
                           java.lang.Object[] values)
```
    Push the specified widget attribute changes to the client-side.
    This just invokes LogicalTerminal.pushWindow(com.goldencode.p2j.ui.WindowConfig).
    
    Overrides:
    
    pushWidgetAttr in class GenericWidget<WindowConfig>
    
    Parameters:
    
    fnames - The list of config field names.
    
    values - The list of new config field values.
  - useHandleChainSiblings
```
protected boolean useHandleChainSiblings()
```
    Indicates an implementation of siblings methods.
    
    Overrides:
    
    useHandleChainSiblings in class BaseEntity<WindowConfig>
    
    Returns:
    
    Always true.
  - getValidParentTypes
```
protected java.lang.String[] getValidParentTypes()
```
    Returns the widget types that can act as parent for this widget.
    
    Overrides:
    
    getValidParentTypes in class BaseEntity<WindowConfig>
    
    Returns:
    
    see above.
  - isChained
```
protected boolean isChained()
```
    Check if this resource can be reported as chained.
    
    Overrides:
    
    isChained in class GenericWidget<WindowConfig>
    
    Returns:
    
    Always true.
  - canSetPixelPositionInChui
```
protected boolean canSetPixelPositionInChui()
```
    The method returns false always - windows can't be positioned via pixel in Chui.
    
    Overrides:
    
    canSetPixelPositionInChui in class BaseEntity<WindowConfig>
    
    Returns:
    
    See above.
  - _setVisible
```
protected void _setVisible(boolean visible)
```
    Sets the window's config visibility flag.
    
    Overrides:
    
    _setVisible in class GenericWidget<WindowConfig>
    
    Parameters:
    
    visible - The window's visibility state.
  - pushScreenDefinition
```
protected void pushScreenDefinition()
```
    Push this window definition.
    
    Overrides:
    
    pushScreenDefinition in class GenericWidget<WindowConfig>
  - pushSizeAttrs
```
protected void pushSizeAttrs()
```
    Push all the size-related attributes to the client-size.
    This just invokes LogicalTerminal.pushWindow(com.goldencode.p2j.ui.WindowConfig).
    
    Overrides:
    
    pushSizeAttrs in class BaseEntity<WindowConfig>
  - canPushWidgetAttr
```
protected boolean canPushWidgetAttr()
```
    Returns true if the configuration can be pushed to the client-side.
    
    Overrides:
    
    canPushWidgetAttr in class GenericWidget<WindowConfig>
    
    Returns:
    
    True if the configuration can be pushed to the client-side.
  - afterConfigUpdate
```
public void afterConfigUpdate(WindowConfig 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<WindowConfig>
    
    Overrides:
    
    afterConfigUpdate in class GenericWidget<WindowConfig>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - loadIconInt
```
private boolean loadIconInt(java.lang.String iconSrc,
                            boolean small)
```
    Load icon for window. Internal version.
    
    Parameters:
    
    iconSrc - Icon file name.
    
    small - Flag indicating usage of the small icon case(16x16 in size).
    
    Returns:
    
    true if operation was successful.
  - updateMinMaxSize
```
private void updateMinMaxSize()
```
    The method updates min/max size config fields and should be called after window size is changed.
    Note that min/max size can be indirectly changed only when window size is directly changed, i.e. by assigning WIDTH/HEIGHT attributes for example and not by user input like mouse resize.
  - 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. See super implementation for more information. This implementation disables the truncation logic for windows.
    
    Overrides:
    
    truncatePixelSize in class GenericWidget<WindowConfig>
    
    Parameters:
    
    size - The value of WIDTH/HEIGHT-PIXELS attributes being assigned.
    
    attr - The size attribute to truncate.
    
    Returns:
    
    The truncated size value.

Class WindowWidget

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

Fields inherited from interface com.goldencode.p2j.ui.CommonWindow

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

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

menubar

Constructor Detail

WindowWidget

Method Detail

valid

isKeepFrameZOrder

setKeepFrameZOrder

setKeepFrameZOrder

getFullHeightChars

getFullHeightPixels

getFullWidthChars

getFullWidthPixels

getMaxHeightChars

setMaxHeightChars

setMaxHeightChars

getMaxWidthChars

setMaxWidthChars

setMaxWidthChars

setMaxHeight

setMaxWidth

getMinHeightChars

getMinWidthChars

setMinHeightChars

setMinWidthChars

getMinHeightPixels

getMinWidthPixels

setMinHeightPixels

setMinWidthPixels

setScrollBars

setStatusArea

setTitle

setSensitive

setBgColor

setFgColor

setKeepZOrder

setMessageArea

getMaxHeight

getMaxWidth

isScrollBars

isStatusArea

isKeepZOrder

isMessageArea

getIcon

loadIcon

loadIcon

loadSmallIcon

loadSmallIcon

asWidget

setMaxHeightPixels

setMaxWidthPixels