public class FrameWidget extends PaneEntity<FrameConfig> implements FrameInterface, TopOnlyInterface, BoxInterface, CommonHandleTree, Down, Hoverable
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.
BaseEntity.CharsPixels
Modifier and Type | Field and Description |
---|---|
private FieldGroup |
background
FIELD-GROUP containing background widgets
|
group
config, deleted, frame
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
FrameWidget()
Default constructor which can be used to create a static frame.
|
FrameWidget(boolean dynamic)
Primary constructor.
|
Modifier and Type | Method and Description |
---|---|
protected void |
_setHidden(boolean hidden)
Sets the frame's config
hidden flag . |
protected void |
_setVisible(boolean visible)
Sets the frame's config
visibility flag . |
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)
Get the frame's border size.
|
handle |
getCancelButton()
Gets the cancel button for this frame.
|
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.
|
java.lang.String |
getMousePointerImpl()
Get the MOUSE-POINTER attribute
|
GenericWidget<?> |
getNextTabItem()
Gets the NEXT-TAB-ITEM writable attribute.
|
CommonWidget |
getParent()
Gets the PARENT writable attribute.
|
protected java.lang.String[] |
getValidParentTypes()
Returns the widget types that can act as parent for this widget.
|
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 |
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 |
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 |
isTopOnly()
Gets the TOP-ONLY attribute's value.
|
handle |
lastChild()
Accesses the last widget in the list of contained widgets.
|
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.
|
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 |
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.
|
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 new value for HIDDEN flag.
|
protected void |
setInstantiatingProcedure(handle hproc)
Set the instantiating procedure for this resource.
|
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.
|
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.
|
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 |
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 |
setWidthPixelsWorker(int width)
Sets the value for the attribute WIDTH-PIXELS in the associated config instance.
|
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.
|
getGridFactorHorizontal, getGridFactorVertical, getGridUnitHeightChars, getGridUnitHeightPixels, getGridUnitWidthChars, getGridUnitWidthPixels, getNumSelectedWidgets, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, isBoxSelectable, isDropTarget, isGridSnap, isGridVisible, isThreeD, setBoxSelectable, setDropTarget, setGridFactorHorizontal, setGridFactorVertical, setGridSnap, setGridUnitHeightChars, setGridUnitHeightPixels, setGridUnitWidthChars, setGridUnitWidthPixels, setGridVisible, setThreeD, setThreeD, setVirtHeight, setVirtHeightCharsWorker, setVirtHeightPixels, setVirtHeightPixelsWorker, setVirtWidth, setVirtWidthCharsWorker, setVirtWidthPixels, setVirtWidthPixelsWorker
canSetPixelPositionInChui, changeFontWorker, getBgColor, getColumn, getDColor, getFgColor, getFont, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getPfColor, getPrevSibling, getRow, getTitle, getTooltip, getWidthChars, getWidthPixels, getX, getY, isResizable, isTabStop, prepareSizeChars, prepareSizePixels, resetAutoResize, setAlign, setBgColor, setBgColor, setBgColor, setColon, setColon, setColumn, setColumn, setColumnOrRowWorker, setDColor, setDColor, setDColor, setFgColor, setFgColor, setFgColor, setFont, setGroup, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setPfColor, setPfColor, setPfColor, setResizable, setResizable, setRow, setRow, setTabStop, setTabStop, setTitle, setTitle, setTooltip, setTooltip, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels, setX, setX, setXOrYWorker, setY, setY, validColumnOrRow
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _setDynamic, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, cleanup, colorDisplay, colorPrompt, config, deselectRows, disable, dynamic, enable, finishConfigProcessing, finishSetup, getColumnFont, getColumnLabel, getContextHelpId, getConvert3D, getCursorOffset, getDataType, getDbName, getFirstTabItem, getFormat, getFrame, getHelp, getHWND, getId, getLabel, getLabelFont, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getPreviousTabItem, getQuery, getRetainShape, getScreenValue, getScreenValue, getSideLabelHandle, getStretchToFit, getTable, getTitleFont, getTransparent, getWidgetId, getWindow, hasNameReadOnly, hasParent, hide, inputValue, isAutoResize, isChained, isChecked, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isModified, isMultiple, isNotEntered, isReadOnly, isSelectable, isSelected, isSelected, isSensitive, isTextSelected, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, name, notQueryable, notSettable, notWorker, preRealizeCheck, processSideLabel, pushScreenDefinition, readOnlyError, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoResize, setAutoResize, setAutoReturn, setBlank, setChecked, setChecked, setColumnFont, setColumnFont, setColumnLabel, setColumnLabel, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setCursorOffset, setCursorOffset, setDataType, setDataType, setDbname, setDeblank, setDisableAutoZap, setFirstTabItem, setFont, setFormat, setFormat, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHeader, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, 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, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setValidation, setVertical, setVisible, setWidgetId, setWidgetId, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateLayout, widgetName
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData
getResourceType, id, id, instantiatingProcedure, invalidAttribute, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget
setBoxSelectable, setGridFactorHorizontal, setGridFactorVertical, setGridSnap, setGridUnitHeightChars, setGridUnitHeightPixels, setGridUnitWidthChars, setGridUnitWidthPixels, setGridVisible
setScreenValue
getPrivateData, setPrivateData, setPrivateData
getResourceType
id, id, unknown
private FieldGroup background
public FrameWidget()
public FrameWidget(boolean dynamic)
dynamic
- Flag indicating if this is a static or dynamic resource.public java.lang.String type()
DIALOG-BOX
. Otherwise,
its type is FRAME
.type
in class HandleResource
public void name(java.lang.String name)
name
in interface Nameable
name
in class HandleChain
name
- New value for the attribute.public void name(character name)
name
in interface Nameable
name
in class HandleChain
name
- New value for the attribute.public GenericWidget<?> getNextTabItem()
getNextTabItem
in interface CommonWidget
getNextTabItem
in class GenericWidget<FrameConfig>
public void setNextTabItem(GenericWidget<?> n)
setNextTabItem
in interface CommonWidget
setNextTabItem
in class GenericWidget<FrameConfig>
n
- The new value for the NEXT-TAB-ITEM attribute.public logical isAttrSpace()
public void setAttrSpace(logical space)
space
- The new value for the ATTR-SPACE attribute.public void setAttrSpace(boolean space)
space
- The new value for the ATTR-SPACE attribute.public logical isCentered()
isCentered
in interface FrameInterface
true
if the frame is centered.public void setCentered(boolean center)
setCentered
in interface FrameInterface
center
- true
if the frame is to be centered.public void setCentered(logical center)
setCentered
in interface FrameInterface
center
- true
if the frame is to be centered.public handle getDefaultButton()
getDefaultButton
in interface FrameInterface
public void setDefaultButton(handle defaultButton)
setDefaultButton
in interface FrameInterface
defaultButton
- handle to current default button.public handle getCancelButton()
getCancelButton
in interface FrameInterface
public void setCancelButton(handle cancelButton)
setCancelButton
in interface FrameInterface
cancelButton
- button widget that receives the CHOOSE event when a user cancels the current frame
or dialog box by pressing the ESC key.public handle currentIteration()
currentIteration
in interface IterableResource
public void setCurrentIteration(handle newIter)
setCurrentIteration
in interface IterableResource
newIter
- A handle
for the current iteration of the frame.public decimal borderTopChars()
borderTopChars
in interface FrameInterface
getBorderSize(boolean, boolean)
public decimal borderLeftChars()
borderLeftChars
in interface FrameInterface
getBorderSize(boolean, boolean)
public decimal borderRightChars()
borderRightChars
in interface FrameInterface
getBorderSize(boolean, boolean)
public decimal borderBottomChars()
borderBottomChars
in interface FrameInterface
getBorderSize(boolean, boolean)
public integer borderTopPixels()
borderTopPixels
in interface FrameInterface
getBorderSize(boolean, boolean)
public integer borderLeftPixels()
borderLeftPixels
in interface FrameInterface
getBorderSize(boolean, boolean)
public integer borderRightPixels()
borderRightPixels
in interface FrameInterface
getBorderSize(boolean, boolean)
public integer borderBottomPixels()
borderBottomPixels
in interface FrameInterface
getBorderSize(boolean, boolean)
public void setDialogBox(boolean dialogBox)
dialogBox
- new value for the dialog box flagpublic boolean isDialogBox()
true
if this frame is a dialog box.public void setDown(int64 down)
public void setDown(long down)
public integer getDown()
public boolean isDown()
true
if frame is DOWN frame.true
if frame is DOWN frame.public void setHidden(boolean hidden)
setHidden
in interface CommonWidget
setHidden
in class GenericWidget<FrameConfig>
hidden
- The new boolean value for the HIDDEN attribute.public void setVisible(boolean visible)
setVisible
in interface CommonWidget
setVisible
in class GenericWidget<FrameConfig>
visible
- The new value for the Progress VISIBLE attribute.public comhandle getComHandle()
This is a non-functional stub for now.
public void hide(boolean noPause)
This method corresponds to the Progress statement: HIDE FRAME
hide
in interface CommonWidget
hide
in class GenericWidget<FrameConfig>
noPause
- true
causes omission of any pauses which would
be necessary otherwise.public void view()
This method corresponds to the Progress statement: VIEW FRAME
view
in interface CommonWidget
view
in class GenericWidget<FrameConfig>
public logical isSelected()
isSelected
in interface CommonWidget
isSelected
in class BaseEntity<FrameConfig>
public void setSelected(logical sel)
setSelected
in interface CommonWidget
setSelected
in class BaseEntity<FrameConfig>
sel
- The new value for the SELECTED attribute.public void setSelected(boolean sel)
setSelected
in interface CommonWidget
setSelected
in class BaseEntity<FrameConfig>
sel
- The new value for the SELECTED attribute.public logical isMovable()
isMovable
in interface CommonWidget
isMovable
in class BaseEntity<FrameConfig>
true
, the widget is movable via direct manipulation.public void setMovable(boolean movable)
setMovable
in interface CommonWidget
setMovable
in class BaseEntity<FrameConfig>
movable
- true
to enable movable direct manipulation.public void setMovable(logical movable)
setMovable
in interface CommonWidget
setMovable
in class BaseEntity<FrameConfig>
movable
- true
to enable movable direct manipulation.public logical isScrollable()
isScrollable
in interface CommonWidget
isScrollable
in class GenericWidget<FrameConfig>
public void setScrollable(logical scroll)
setScrollable
in interface CommonWidget
setScrollable
in class GenericWidget<FrameConfig>
scroll
- The new value for the SCROLLABLE attribute.public void setScrollable(boolean scroll)
setScrollable
in interface CommonWidget
setScrollable
in class GenericWidget<FrameConfig>
scroll
- The new value for the SCROLLABLE attribute.public handle firstChild()
firstChild
in interface CommonHandleTree
null
if no widgets are contained.public handle lastChild()
lastChild
in interface CommonHandleTree
null
if no widgets are contained.public void setFrame(GenericFrame frame)
setFrame
in interface CommonWidget
setFrame
in class GenericWidget<FrameConfig>
frame
- The containing instance.protected boolean useHandleChainSiblings()
useHandleChainSiblings
in class BaseEntity<FrameConfig>
true
.public logical isBox()
isBox
in interface BoxInterface
public void setBox(logical value)
setBox
in interface BoxInterface
value
- the new value of the attributepublic void setBox(boolean value)
setBox
in interface BoxInterface
value
- the new value of the attributepublic void setTopOnly(boolean topOnly)
setTopOnly
in interface TopOnlyInterface
topOnly
- true
if the option/attribute is set to ON.public void setTopOnly(logical topOnly)
setTopOnly
in interface TopOnlyInterface
topOnly
- true
if the attribute is set to ON.public logical isTopOnly()
isTopOnly
in interface TopOnlyInterface
public void setOverlay(boolean overlay)
setOverlay
in interface FrameInterface
overlay
- true
if the option/attribute is set to ON.public void setOverlay(logical overlay)
setOverlay
in interface FrameInterface
overlay
- true
if the attribute is set to ON.public logical isOverlay()
isOverlay
in interface FrameInterface
public void setBackground(FieldGroup background)
background
- background fieldgrouppublic FieldGroup getBackground()
public handle backgroundIteration()
backgroundIteration
in interface FrameInterface
public logical validateFields(boolean enabledOnly)
validateFields
in class GenericWidget<FrameConfig>
enabledOnly
- If true
, VALIDATE will
check enabled fields only. Otherwise, the VALIDATE method validates all fields,
whether enabled or not.true
if the validation is successful.public void setMousePointerName(java.lang.String name)
setMousePointerName
in interface Hoverable
name
- the attribute valuepublic java.lang.String getMousePointerImpl()
getMousePointerImpl
in interface Hoverable
public void setParent(GenericWidget<?> widget)
setParent
in interface CommonWidget
setParent
in class BaseEntity<FrameConfig>
widget
- The new value for the PARENT attribute.protected boolean implicitDeletion()
implicitDeletion
in class GenericWidget<FrameConfig>
true
if the INSTANTIATING-PROCEDURE attribute is unknown (i.e. the
instantiating procedure has been deleted).public CommonWidget getParent()
For FRAMEs, this is either the containing WINDOW or the parent FIELD-GROUP, if attached to a frame.
getParent
in interface CommonWidget
getParent
in class BaseEntity<FrameConfig>
public handle getFrameHandle()
getFrameHandle
in interface CommonWidget
getFrameHandle
in class GenericWidget<FrameConfig>
protected boolean isRootFrame()
protected boolean allFramesVisible()
true
if all frame's ascendants are visible.public void delete()
delete
in interface Deletable
delete
in class HandleChain
protected boolean resourceDelete()
resourceDelete
in class GenericWidget<FrameConfig>
true
if the resource was deleted.protected void setInstantiatingProcedure(handle hproc)
This will set the instantiating procedure only if is not shared or this is the procedure where the frame is registered as shared.
setInstantiatingProcedure
in class HandleResource
hproc
- The procedure where the resource was instantiated.protected java.lang.String[] getValidParentTypes()
getValidParentTypes
in class BaseEntity<FrameConfig>
protected boolean moveToWorker(boolean top)
GenericWidget.moveToTop()
and GenericWidget.moveToBottom()
code.moveToWorker
in class GenericWidget<FrameConfig>
top
- true
if moving to top, false
for bottom.true
if move succeeded.protected void _setVisible(boolean visible)
visibility flag
._setVisible
in class GenericWidget<FrameConfig>
visible
- The frame's visibility state.protected void _setHidden(boolean hidden)
hidden flag
.hidden
- The frame's hidden state.protected boolean validateParent(GenericWidget<?> widget)
validateParent
in class BaseEntity<FrameConfig>
widget
- The widget reference to check.true
if the supplied widget can be used
as a valid parent, false
otherwise.protected boolean validateSize(java.lang.Number value, SizeAttribute attr)
validateSize
in class BaseEntity<FrameConfig>
value
- The input value to validate.attr
- Denotes the kind of size attribute.true
when valid, false
otherwiseprotected void setSizeChars(java.lang.Double value, SizeAttribute attr)
setSizeChars
in class BaseEntity<FrameConfig>
value
- The attribute value. null
denotes an unknown attribute value.attr
- The attribute being set.protected void setSizePixels(java.lang.Integer value, SizeAttribute attr)
setSizePixels
in class BaseEntity<FrameConfig>
value
- The attribute value. null
denotes an unknown attribute value.attr
- The attribute being set.protected void setWidthCharsWorker(double width)
setWidthCharsWorker
in class BaseEntity<FrameConfig>
width
- Valid width value.protected void setHeightCharsWorker(double height)
setHeightCharsWorker
in class BaseEntity<FrameConfig>
height
- Valid height value.protected void setWidthPixelsWorker(int width)
setWidthPixelsWorker
in class BaseEntity<FrameConfig>
width
- Valid width value.protected void setHeightPixelsWorker(int height)
setHeightPixelsWorker
in class BaseEntity<FrameConfig>
height
- Valid height value.protected void setColumnOrRow(boolean isUnknown, double value, boolean row)
setColumnOrRow
in class BaseEntity<FrameConfig>
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.private double getBorderSize(boolean chars, boolean row)
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()
.
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.