public interface CommonWidget extends CommonHandleChain, CommonField, DatabaseInfo, Sizeable, XYCoordinates, ImageWidgetSupport
Modifier and Type | Method and Description |
---|---|
void |
apply(character event)
Applies an event to this widget.
|
void |
apply(double eventCode)
Applies an event to this widget.
|
void |
apply(int64 eventCode)
Applies an event to this widget.
|
void |
apply(java.lang.String event)
Applies an event to this widget.
|
handle |
asWidgetHandle()
Get this widget wrapped in a handle.
|
void |
colorDisplay(ColorSpec cs)
COLOR DISPLAY
|
void |
colorPrompt(ColorSpec cs)
COLOR PROMPT
|
logical |
deselectRows()
Blocks attempts to access this widget method.
|
void |
disable()
Disables this widget.
|
void |
enable()
Enables this widget.
|
integer |
getBgColor()
Get BGCOLOR attribute.
|
decimal |
getColumn()
Blocks attempts to access this attribute.
|
integer |
getColumnFont()
Get the COLUMN-FONT attribute of this browse widget.
|
integer |
getContextHelpId()
Gets the CONTEXT-HELP-ID writable attribute.
|
integer |
getCursorOffset()
Obtains the index position of the cursor in a text editing widget.
|
integer |
getDColor()
Blocks attempts to access this attribute.
|
integer |
getFgColor()
Get FGCOLOR attribute.
|
handle |
getFirstTabItem()
Blocks attempts to access this attribute.
|
integer |
getFont()
Get the FONT attribute of this widget.
|
GenericFrame |
getFrame()
Gets the containing frame instance.
|
decimal |
getFrameColumn()
Blocks attempts to access this attribute.
|
handle |
getFrameHandle()
Gets the FRAME attribute, which is the containing frame instance, as a handle.
|
decimal |
getFrameRow()
Blocks attempts to access this attribute.
|
integer |
getFrameX()
Blocks attempts to access this attribute.
|
integer |
getFrameY()
Blocks attempts to access this attribute.
|
character |
getHelp()
Get the HELP writable attribute.
|
integer |
getHWND()
Gets the integer handle value of the window containing the widget.
|
int |
getId()
Gets the numeric ID of this widget (this is used as an index into the
screen-buffer among other things).
|
integer |
getLabelFont()
Get the LABEL-FONT attribute of this browse widget.
|
java.lang.String |
getLabelStr()
Get the label text for this widget.
|
decimal |
getMaxHeightChars()
Blocks attempts to access this attribute.
|
decimal |
getMaxWidthChars()
Blocks attempts to access this attribute.
|
character |
getMenuKey()
Gets the MENU-KEY attribute.
|
integer |
getMenuMouse()
Gets the MENU-MOUSE attribute.
|
character |
getMousePointer()
Get the value of the MOUSE-POINTER attribute for a widget
|
integer[] |
getMousePosition()
Returns current mouse cursor position relative to this widget.
|
CommonWidget |
getNextTabItem()
Blocks attempts to access this attribute.
|
integer |
getNumColumns()
Blocks attempts to access this widget method.
|
integer |
getNumSelectedRows()
Blocks attempts to access this attribute.
|
CommonWidget |
getParent()
Blocks attempts to access this attribute.
|
handle |
getParentHandle()
Gets the PARENT attribute, as a handle.
|
integer |
getPfColor()
Blocks attempts to access this attribute.
|
handle |
getPopupMenu()
Get widget POPUP-MENU.
|
handle |
getPreviousTabItem()
Get the PREV-TAB-ITEM attribute of this widget.
|
P2JQuery |
getQuery()
Blocks attempts to access this attribute.
|
decimal |
getRow()
Blocks attempts to access this attribute.
|
character |
getScreenValue()
Obtain the current value in the screen buffer of the backing data for
this widget and return it as a
character type. |
handle |
getSideLabelHandle()
Obtains the text widget that is used as the side label for this widget.
|
character |
getTitle()
Blocks attempts to access this attribute.
|
integer |
getTitleFont()
Get the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.
|
character |
getTooltip()
Queries the TOOLTIP attribute of this widget.
|
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.
|
integer |
getWidgetId()
Gets the WIDGET-ID writable attribute.
|
handle |
getWindow()
Gets the WINDOW attribute.
|
void |
hide()
Hides this widget.
|
void |
hide(boolean noPause)
Hides this widget.
|
BaseDataType |
inputValue()
Reads the INPUT-VALUE attribute (value of the widget currently in the screen-buffer).
|
logical |
isAutoResize()
Get AUTO-RESIZE attribute value.
|
logical |
isChecked()
Gets the CHECKED writable attribute.
|
logical |
isEntered()
Checks whether the widget is changed during the most recent operation.
|
logical |
isFocusedRowSelected()
Checks whether the row that has the focus is selected.
|
logical |
isHidden()
Gets the HIDDEN writable attribute.
|
logical |
isKeepFrameZOrder()
Blocks attempts to access this attribute.
|
logical |
isManualHighlight()
Get value of the MANUAL-HIGHLIGHT attribute.
|
logical |
isModified()
Queries if the SCREEN-VALUE attribute for this widget was changed.
|
logical |
isMovable()
Queries if the user is allowed to move this widget using direct manipulation.
|
logical |
isMultiple()
Blocks attempts to access this attribute.
|
logical |
isNotEntered()
Checks whether the widget is not changed during the most recent
operation.
|
logical |
isReadOnly()
Checks whether the widget is write-protected.
|
logical |
isResizable()
The getter side of RESIZABLE attribute.
|
logical |
isScrollable()
Blocks attempts to access this attribute.
|
logical |
isSelectable()
Get the SELECTABLE writable attribute.
|
logical |
isSelected()
Blocks attempts to access this attribute.
|
logical |
isSelected(character item)
Blocks attempts to access this widget method.
|
logical |
isSelected(int64 index)
Blocks attempts to access this widget method.
|
logical |
isTabStop()
Get value of the TAB-STOP attribute.
|
logical |
isThreeD()
Check if window has THREE-D option set.
|
boolean |
isValidatable()
Checks if the widget has a validation expression registered.
|
logical |
isVisible()
Get the VISIBLE writable attribute.
|
logical |
loadMousePointer(character pointerName)
The implementation of LOAD-MOUSE-POINTER() method.
|
logical |
loadMousePointer(java.lang.String pointerName)
The implementation of LOAD-MOUSE-POINTER() method.
|
logical |
moveAfterTab(CommonWidget widget)
This method implements MOVE-AFTER-TAB function.
|
logical |
moveAfterTab(handle widget)
This method implements MOVE-AFTER-TAB function.
|
logical |
moveBeforeTabItem(CommonWidget widget)
Assigns the current widget to the tab position before the specified in the same field group.
|
logical |
moveBeforeTabItem(handle widget)
Assigns the current widget to the tab position before the specified in the same field group.
|
logical |
moveToBottom()
This method implements MOVE-TO-BOTTOM function.
|
logical |
moveToTop()
This method implements MOVE-TO-TOP function.
|
boolean |
preRealizeCheck()
Reports if this widget object is valid to realize.
|
void |
realize()
Stub implementation of the 'realize' method.
|
logical |
refresh()
Blocks attempts to access this widget method.
|
logical |
selectAll()
Blocks attempts to access this widget method.
|
logical |
selectFocusedRow()
Blocks attempts to access this widget method.
|
void |
setAtFormatLength(int length)
Set the length of the format for the widget's @ phrases.
|
void |
setAutoResize(boolean autoResize)
Set AUTO-RESIZE attribute value.
|
void |
setAutoResize(logical autoResize)
Set AUTO-RESIZE attribute value.
|
void |
setAutoReturn(boolean autoReturn)
Sets the AUTO-RETURN option.
|
void |
setBgColor(integer bgcolor)
Sets the BGCOLOR writable attribute.
|
void |
setBlank(boolean blank)
Sets the BLANK option.
|
void |
setChecked(boolean checked)
Sets the CHECKED writable attribute.
|
void |
setChecked(logical checked)
Sets the CHECKED writable attribute.
|
void |
setColumn(double column)
Blocks attempts to access this attribute.
|
void |
setColumn(NumberType column)
Blocks attempts to access this attribute.
|
void |
setColumnFont(int64 fontNum)
Set the COLUMN-FONT attribute of this browse widget.
|
void |
setColumnFont(long fontNum)
Set the COLUMN-FONT attribute of this browse widget.
|
void |
setContextHelpId(int id)
Sets the WIDGET-ID writable attribute.
|
void |
setContextHelpId(integer id)
Sets the CONTEXT-HELP-ID writable attribute.
|
void |
setCursorOffset(double offset)
Sets the index position of the cursor in a text editing widget.
|
void |
setCursorOffset(NumberType offset)
Sets the index position of the cursor in a text editing widget.
|
void |
setDColor(Color displayColor)
Sets the display color.
|
void |
setDColor(NumberType param)
Sets the display color.
|
void |
setDeblank(boolean deblank)
Sets the DEBLANK option.
|
void |
setDisableAutoZap(boolean disableAutoZap)
Sets the DISABLE-AUTO-ZAP option.
|
void |
setFgColor(integer fgcolor)
Sets the FGCOLOR writable attribute.
|
void |
setFirstTabItem(handle h)
Blocks attempts to access this attribute.
|
void |
setFont(int64 fontNum)
Set the FONT attribute of this widget.
|
void |
setFont(long fontNum)
Set the FONT attribute of this widget.
|
void |
setFormat(java.lang.String format)
Sets the format specification.
|
void |
setFrame(FrameWidget frame)
Sets the containing frame instance.
|
void |
setFrame(GenericFrame frame)
Sets the containing frame instance.
|
void |
setFrame(handle hFrame)
Sets the containing frame instance.
|
void |
setFrameHandle(CommonFrame frame)
Sets the FRAME attribute, containing frame instance.
|
void |
setFrameHandle(FrameWidget frame)
Sets the FRAME attribute, containing frame instance.
|
void |
setFrameHandle(handle h)
Sets the FRAME attribute, containing frame instance.
|
void |
setGroup(Group group)
Establishes a relationship between the container and the elements in
a given widget group.
|
void |
setHeader(boolean header)
Mark widget as a header.
|
void |
setHelp(character help)
Sets the help text.
|
void |
setHelp(java.lang.String help)
Sets the help text.
|
void |
setHidden(boolean hidden)
Sets the HIDDEN writable attribute.
|
void |
setHidden(logical hidden)
Sets the HIDDEN writable attribute.
|
void |
setId(int id)
Sets the numeric ID of this widget (this is used as an index into the
screen-buffer among other things).
|
void |
setKeepFrameZOrder(boolean k)
Blocks attempts to access this attribute.
|
void |
setKeepFrameZOrder(logical k)
Blocks attempts to access this attribute.
|
void |
setLabelFont(int64 fontNum)
Set the LABEL-FONT attribute of this browse widget.
|
void |
setLabelFont(long fontNum)
Set the LABEL-FONT attribute of this browse widget.
|
void |
setManualHighlight(boolean value)
Set value of the MANUAL-HIGHLIGHT attribute.
|
void |
setManualHighlight(logical value)
Set value of the BLANK attribute.
|
void |
setMaxHeightChars(decimal m)
Blocks attempts to access this attribute.
|
void |
setMaxWidthChars(decimal m)
Blocks attempts to access this attribute.
|
void |
setMenuKey(character value)
Sets the MENU-KEY writable attribute.
|
void |
setMenuKey(java.lang.String value)
Sets the MENU-KEY writable attribute.
|
void |
setMenuMouse(int value)
Sets the MENU-MOUSE writable attribute.
|
void |
setMenuMouse(int64 value)
Sets the MENU-MOUSE writable attribute.
|
void |
setModified(boolean modified)
Defines if the SCREEN-VALUE attribute for this widget has changed.
|
void |
setModified(logical modified)
Defines if the SCREEN-VALUE attribute for this widget has changed.
|
void |
setMovable(boolean movable)
Defines if the user is allowed to move this widget using direct manipulation.
|
void |
setMovable(logical movable)
Defines if the user is allowed to move this widget using direct manipulation.
|
void |
setMultiple(boolean multiple)
Blocks attempts to access this attribute.
|
void |
setMultiple(logical multiple)
Blocks attempts to access this attribute.
|
void |
setNextTabItem(GenericWidget<?> n)
Blocks attempts to access this attribute.
|
void |
setNumSelectedRows(int64 r)
Blocks attempts to access this attribute.
|
void |
setParent(GenericWidget<?> p)
Blocks attempts to access this attribute.
|
void |
setParentHandle(CommonWidget w)
Sets the PARENT attribute to the specified widget.
|
void |
setParentHandle(handle h)
Sets the PARENT attribute to the resource specified in the given handle.
|
void |
setPfColor(Color inputColor)
Sets the input (prompt/edit mode) color.
|
void |
setPfColor(NumberType param)
Sets the input (prompt/edit mode) color.
|
void |
setPopupMenu(handle menu)
Set widget POPUP-MENU.
|
void |
setPopupMenu(MenuWidget menu)
Set widget POPUP-MENU.
|
void |
setQuery(P2JQuery q)
Blocks attempts to access this attribute.
|
void |
setReadOnly(logical r)
Sets the READ-ONLY attribute of the widget.
|
void |
setResizable(boolean on)
The setter side of RESIZABLE attribute.
|
void |
setResizable(logical on)
The setter side of RESIZABLE attribute.
|
void |
setRow(double row)
Blocks attempts to access this attribute.
|
void |
setRow(NumberType row)
Blocks attempts to access this attribute.
|
default void |
setScreenValue(BaseDataType value)
Set the current value in the screen buffer of the backing data for this widget.
|
void |
setScreenValue(character value)
Set the current value in the screen buffer of the backing data for
this widget.
|
void |
setScrollable(boolean s)
Blocks attempts to access this attribute.
|
void |
setScrollable(logical s)
Blocks attempts to access this attribute.
|
void |
setSelectable(boolean value)
Get the SELECTABLE writable attribute.
|
void |
setSelectable(logical value)
Set the SELECTABLE writable attribute.
|
void |
setSelected(boolean s)
Blocks attempts to access this attribute.
|
void |
setSelected(logical s)
Blocks attempts to access this attribute.
|
void |
setSensitive(logical s)
Sets new value of SENSITIVE attribute.
|
void |
setSideLabelHandle(handle label)
Sets the text widget that is used as the side label for this widget.
|
void |
setTabStop(boolean value)
Set value of the TAB-STOP attribute.
|
void |
setTabStop(logical value)
Set value of the TAB-STOP attribute.
|
void |
setThreeD(boolean threeD)
Enable/disable 3D look.
|
void |
setThreeD(logical threeD)
Enable/disable 3D look.
|
void |
setTitle(character t)
Blocks attempts to access this attribute.
|
void |
setTitle(java.lang.String t)
Blocks attempts to access this attribute.
|
void |
setTitleFont(int64 fontNum)
Set the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.
|
void |
setTitleFont(long fontNum)
Set the TITLE-FONT attribute of this browse, dialog, frame or pop-up menu.
|
void |
setTooltip(character tooltip)
Sets new value of TOOLTIP attribute.
|
void |
setTooltip(java.lang.String tooltip)
Sets new value of TOOLTIP attribute.
|
void |
setValidation(ValidationExpr valexp,
java.lang.String valmsg)
Registers callbacks for validation processing (during editing) for any input into this
widget.
|
void |
setValidation(ValidationExpr valexp,
ValidationMsg valmsg)
Registers callbacks for validation processing (during editing) for any input into this
widget.
|
void |
setVertical(boolean direction)
Blocks attempts to access this attribute.
|
void |
setVirtHeight(NumberType height)
Set VIRTUAL-HEIGHT-CHARS attribute.
|
void |
setVirtHeightPixels(NumberType height)
Set VIRTUAL-HEIGHT-PIXELS attribute.
|
void |
setVirtWidth(NumberType width)
Set VIRTUAL-WIDTH-CHARS attribute.
|
void |
setVirtWidthPixels(NumberType width)
Set VIRTUAL-WIDTH-CHARS attribute.
|
void |
setVisible(boolean visible)
Set the VISIBLE writable attribute.
|
void |
setVisible(logical visible)
Set the VISIBLE writable attribute.
|
void |
setWidgetId(int id)
Sets the WIDGET-ID writable attribute.
|
void |
setWidgetId(integer id)
Sets the WIDGET-ID writable attribute.
|
void |
underline()
Underlines this widget on the screen.
|
void |
underline(Stream stream)
Underlines this widget on the screen.
|
boolean |
valid()
Reports if this widget object is valid for use.
|
logical |
validateFields()
Processes validation rules (if they exist), error checking and any other constraint
processing that needs to be applied.
|
logical |
validateFields(character val)
Processes validation rules (if they exist), error checking and any other constraint
processing that needs to be applied.
|
logical |
validateFields(java.lang.String val)
Processes validation rules (if they exist), error checking and any other constraint
processing that needs to be applied.
|
void |
view()
Shows this widget.
|
getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData
getResourceType, readOnlyError
id, id, unknown
getColumnLabel, getDataType, getFormat, getLabel, setColumnLabel, setColumnLabel, setDataType, setDataType, setFormat, setLabel, setLabel
getDbName, getTable
getHeightChars, getHeightPixels, getWidthChars, getWidthPixels, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidthChars, setWidthChars, setWidthPixels, setWidthPixels
getX, getY, setX, setY
getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent
getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D
void apply(character event)
This method corresponds to the Progress statement: APPLY widget
event
- The name of the event.void apply(double eventCode)
This method corresponds to the Progress statement: APPLY widget
eventCode
- The event code.void apply(int64 eventCode)
This method corresponds to the Progress statement: APPLY widget
eventCode
- The event code.void apply(java.lang.String event)
This method corresponds to the Progress statement: APPLY widget
event
- The name of the event.handle asWidgetHandle()
void colorDisplay(ColorSpec cs)
cs
- Color specification.void colorPrompt(ColorSpec cs)
cs
- Color specification.logical deselectRows()
void disable()
This method corresponds to the Progress statement: DISABLE widget
void enable()
This method corresponds to the Progress statement: ENABLE widget
handle getPreviousTabItem()
integer getFont()
void setFont(long fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.void setFont(int64 fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.integer getColumnFont()
void setColumnFont(long fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.void setColumnFont(int64 fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.integer getLabelFont()
void setLabelFont(long fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.void setLabelFont(int64 fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.integer getTitleFont()
void setTitleFont(long fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.void setTitleFont(int64 fontNum)
fontNum
- An entry in the font-table or unknown to refer the default font.decimal getColumn()
decimal getFrameColumn()
integer getCursorOffset()
integer getDColor()
GenericFrame getFrame()
handle getFrameHandle()
character getHelp()
int getId()
java.lang.String getLabelStr()
decimal getMaxHeightChars()
decimal getMaxWidthChars()
CommonWidget getNextTabItem()
integer getNumColumns()
integer getNumSelectedRows()
CommonWidget getParent()
handle getParentHandle()
integer getPfColor()
P2JQuery getQuery()
decimal getRow()
decimal getFrameRow()
handle getSideLabelHandle()
character getScreenValue()
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.character
type or the empty
string if the screen buffer value is uninitialized.character getTitle()
character getTooltip()
integer getFrameX()
integer getFrameY()
void hide()
This method corresponds to the Progress statement: HIDE widget
void hide(boolean noPause)
This method corresponds to the Progress statement: HIDE widget
noPause
- true
causes omission of any pauses which would
be necessary otherwise.logical isChecked()
logical isEntered()
true
if this widget has changed its value.logical isFocusedRowSelected()
true
if the focused row is selected.logical isHidden()
logical isKeepFrameZOrder()
logical isModified()
true
, the widget's screen value was changed.logical isMovable()
true
, the widget is movable via direct manipulation.logical isMultiple()
logical isNotEntered()
true
if this widget has not changed its value.logical isReadOnly()
true
if the widget is write-protected.boolean preRealizeCheck()
true
if the widget can be relized.logical isScrollable()
logical isSelected()
logical isSelected(character item)
item
- Not used.logical isSelected(int64 index)
index
- Not used.boolean valid()
The validity of the widget object is determined solely by the scope of the containing frame.
valid
in interface WrappedResource
true
if we are valid (can be used).boolean isValidatable()
true
if the widget will have a validation expression executed
during editing.logical isVisible()
logical isSelectable()
void setSelectable(logical value)
value
- the new value of the attributevoid setSelectable(boolean value)
value
- the new value of the attributelogical moveAfterTab(CommonWidget widget)
widget
- Widget reference.true
if operation was successful.logical moveAfterTab(handle widget)
widget
- The handle of the widget after whose tab position this will be moved.true
if operation was successful.logical moveToBottom()
true
if operation was successful.logical moveToTop()
true
if operation was successful.logical refresh()
logical selectAll()
logical selectFocusedRow()
void setAutoReturn(boolean autoReturn)
autoReturn
- true
if the option is set to ON.void setAutoResize(logical autoResize)
autoResize
- New value for the attribute.void setAutoResize(boolean autoResize)
autoResize
- New value for the attribute.logical isAutoResize()
void setBlank(boolean blank)
blank
- true
if the option is set to ON.void setChecked(boolean checked)
checked
- The new value for the CHECKED attribute.void setChecked(logical checked)
checked
- The new value for the CHECKED attribute.void setColumn(double column)
column
- Not used.void setColumn(NumberType column)
column
- Not used.void setCursorOffset(double offset)
offset
- The character index at which the cursor is to be placed.void setCursorOffset(NumberType offset)
offset
- The character index at which the cursor is to be placed.void setDColor(Color displayColor)
displayColor
- The display color.void setDColor(NumberType param)
param
- The display color.void setDeblank(boolean deblank)
deblank
- true
if the option is set to ON.void setDisableAutoZap(boolean disableAutoZap)
disableAutoZap
- true
if the option is set to ON.void setFormat(java.lang.String format)
setFormat
in interface CommonField
format
- The format specification.void setFrame(FrameWidget frame)
frame
- GenericFrame
instance that contains this widgetvoid setFrameHandle(handle h)
h
- a handle containing the GenericFrame
instance that contains
this widgetvoid setFrameHandle(CommonFrame frame)
frame
- the frame instance that will contain this widget.void setFrameHandle(FrameWidget frame)
frame
- The frame instance that will contain this widget.void setFrame(GenericFrame frame)
frame
- GenericFrame
instance that contains this widgetvoid setFrame(handle hFrame)
hFrame
- handle which is expected to contain a FrameWidget
instancevoid setGroup(Group group)
group
- The container of the widget.void setHeader(boolean header)
header
- New value of the flag.void setHelp(character help)
help
- The new help text.void setHelp(java.lang.String help)
help
- The new help text.void setHidden(boolean hidden)
hidden
- The new value for the HIDDEN attribute.void setHidden(logical hidden)
hidden
- The new value for the HIDDEN attribute.void setId(int id)
id
- The numeric ID of this widget.void setKeepFrameZOrder(boolean k)
k
- Not used.void setKeepFrameZOrder(logical k)
k
- Not used.void setMaxHeightChars(decimal m)
m
- Not used.void setMaxWidthChars(decimal m)
m
- Not used.void setModified(boolean modified)
modified
- true
to mark the screen value as changed.void setModified(logical modified)
modified
- true
to mark the screen value as changed.void setMovable(boolean movable)
movable
- true
to enable movable direct manipulation.void setMovable(logical movable)
movable
- true
to enable movable direct manipulation.void setMultiple(boolean multiple)
multiple
- Not used.void setMultiple(logical multiple)
multiple
- Not used.void setNextTabItem(GenericWidget<?> n)
n
- Not used.void setNumSelectedRows(int64 r)
r
- Not used.void setParent(GenericWidget<?> p)
p
- Not used.void setParentHandle(handle h)
h
- The handle with the parent resource.void setParentHandle(CommonWidget w)
w
- The parent widgetvoid setPfColor(Color inputColor)
inputColor
- The color to use for when in "input" mode.void setPfColor(NumberType param)
param
- The color to use.handle getPopupMenu()
void setPopupMenu(handle menu)
menu
- The pop-up menu handle.void setPopupMenu(MenuWidget menu)
menu
- The pop-up menu widget.void setQuery(P2JQuery q)
q
- Not used.void setReadOnly(logical r)
r
- true
if the widget should be write-protected.void setRow(double row)
row
- Not used.void setRow(NumberType row)
row
- Not used.void setSideLabelHandle(handle label)
label
- The handle to the text widget to be used as the side label of this widget.void setScreenValue(character value)
null
then this
widget will be set to the uninitialized value.value
- The new value for the widget, use null
to set
the value as uninitialized.default void setScreenValue(BaseDataType value)
null
then this widget will be set to the uninitialized value.
This method is designed to be used only with _POLY assignments. It will perform automatic conversion if this is possible.
value
- The new value for the widget, use null
to set the value as uninitialized.void setScrollable(boolean s)
s
- Not used.void setScrollable(logical s)
s
- Not used.void setSelected(boolean s)
s
- Not used.void setSelected(logical s)
s
- Not used.void setSensitive(logical s)
s
- new value of SENSITIVE attributevoid setTitle(character t)
t
- Not used.void setTitle(java.lang.String t)
t
- Not used.void setTooltip(character tooltip)
tooltip
- new value of TOOLTIP attributevoid setTooltip(java.lang.String tooltip)
tooltip
- new value of TOOLTIP attributevoid setValidation(ValidationExpr valexp, ValidationMsg valmsg)
valexp
- The Function
to call to determine if the edits are allowed.valmsg
- The Function
used to generate the error message on a validation
failure.void setValidation(ValidationExpr valexp, java.lang.String valmsg)
valexp
- The Function
to call to determine if the edits are allowed.valmsg
- The error message on a validation failure.void setVertical(boolean direction)
direction
- Not used.void setVisible(boolean visible)
visible
- The new value for the VISIBLE attribute.void setVisible(logical visible)
visible
- The new value for the VISIBLE attribute.void underline()
This method corresponds to the Progress statement: UNDERLINE
void underline(Stream stream)
This method corresponds to the Progress statement: UNDERLINE
stream
- An explicit stream which will be used for the output.logical validateFields()
true
if the validation is successful.logical validateFields(character val)
val
- The only correct argument is "ENABLED-FIELDS" string. If specified, VALIDATE will
check enabled fields only. Otherwise, the VALIDATE method validates all fields,
whether enabled or not.true
if the validation is successful.logical validateFields(java.lang.String val)
val
- The only correct argument is "ENABLED-FIELDS" string. If specified, VALIDATE will
check enabled fields only. Otherwise, the VALIDATE method validates all fields,
whether enabled or not.true
if the validation is successful.void view()
This method corresponds to the Progress statement: VIEW widget
integer getHWND()
handle getFirstTabItem()
void setFirstTabItem(handle h)
h
- Not used.logical moveBeforeTabItem(CommonWidget widget)
widget
- The handle of the widget before whose we need to make new assignment.true
if operation was successful.logical moveBeforeTabItem(handle widget)
widget
- The handle of the widget before whose we need to make new assignment.true
if operation was successful.logical isThreeD()
true
if window has THREE-D option set.void setThreeD(boolean threeD)
threeD
- New flag value.void setThreeD(logical threeD)
threeD
- New flag value.decimal getVirtHeight()
void setVirtHeight(NumberType height)
height
- VIRTUAL-HEIGHT-CHAR valuedecimal getVirtWidth()
void setVirtWidth(NumberType width)
width
- VIRTUAL-WIDTH-CHAR valueinteger getVirtHeightPixels()
void setVirtHeightPixels(NumberType height)
height
- VIRTUAL-HEIGHT-PIXELS valueinteger getVirtWidthPixels()
void setVirtWidthPixels(NumberType width)
width
- VIRTUAL-WIDTH-CHAR valueinteger getBgColor()
void setBgColor(integer bgcolor)
bgcolor
- The new value for the bGCOLOR attribute.integer getFgColor()
void setFgColor(integer fgcolor)
fgcolor
- The new value for the FGCOLOR attribute.void setWidgetId(integer id)
id
- The new value for the WIDGET-ID attribute.void setWidgetId(int id)
id
- The new value for the WIDGET-ID attribute.integer getWidgetId()
void setContextHelpId(integer id)
id
- The new value for the CONTEXT-HELP-ID attribute.void setContextHelpId(int id)
id
- The new value for the CONTEXT-HELP-ID attribute.integer getContextHelpId()
void setTabStop(boolean value)
value
- Value of the attribute.void setTabStop(logical value)
value
- Value of the attribute.logical isTabStop()
void setManualHighlight(boolean value)
value
- Value of the attribute.void setManualHighlight(logical value)
value
- Value of the attribute.logical isManualHighlight()
handle getWindow()
void setMenuMouse(int value)
value
- The new value for the MENU-MOUSE attribute (Left 1, Middle 2, Right 3).void setMenuMouse(int64 value)
value
- The new value for the MENU-MOUSE attribute ( (Left 1, Middle 2, Right 3).integer getMenuMouse()
void setMenuKey(java.lang.String value)
value
- The new value for the MENU-KEY attribute.void setMenuKey(character value)
value
- The new value for the MENU-KEY attribute.character getMenuKey()
logical isResizable()
true
is widget is resizable.void setResizable(boolean on)
on
- true
is widget will be resizable.void setResizable(logical on)
on
- true
is widget will be resizable.logical loadMousePointer(java.lang.String pointerName)
pointerName
- The name of the mouse cursor. Here is the list of all cursor names:
APPSTARTING | Arrow with an hourglass beside it |
ARROW | Standard arrow cursor |
CROSS | Cross hairs |
HELP | Arrow with a question mark beside it |
IBEAM | I-beam text cursor |
NO | Circle with a slash through it |
RECTANGLE (NT 3.51 only) | White rectangle |
SIZE | Sizing rectangle |
SIZE-E | Size to right |
SIZE-N | Size to top |
SIZE-NE | Size to top right |
SIZE-NW | Size to top left |
SIZE-S | Size to bottom |
SIZE-SE | Size to bottom right |
SIZE-SW | Size to bottom left |
SIZE-W | Size to left |
UPARROW | Up arrow |
WAIT | System busy |
GLOVE | Glove/finger |
COMPILER-WAIT | Compiler busy |
true
if the mouse pointer is loaded successfully.logical loadMousePointer(character pointerName)
pointerName
- The name of the mouse cursor. Here is the list of all cursor names:
APPSTARTING | Arrow with an hourglass beside it |
ARROW | Standard arrow cursor |
CROSS | Cross hairs |
HELP | Arrow with a question mark beside it |
IBEAM | I-beam text cursor |
NO | Circle with a slash through it |
RECTANGLE (NT 3.51 only) | White rectangle |
SIZE | Sizing rectangle |
SIZE-E | Size to right |
SIZE-N | Size to top |
SIZE-NE | Size to top right |
SIZE-NW | Size to top left |
SIZE-S | Size to bottom |
SIZE-SE | Size to bottom right |
SIZE-SW | Size to bottom left |
SIZE-W | Size to left |
UPARROW | Up arrow |
WAIT | System busy |
GLOVE | Glove/finger |
COMPILER-WAIT | Compiler busy |
true
if the mouse pointer is loaded successfully.BaseDataType inputValue()
character getMousePointer()
integer[] getMousePosition()
The method supports the legacy widget method GET-MOUSE-POSITION. However GET-MOUSE-POSITION is not a real 4GL method but a FWD extension to the language.
null
, the array is always of length 2,
where the index 0 points to the X coordinate and index 1 to the Y coordinate of
the mouse cursor relative to the widget origin.void setAtFormatLength(int length)
length
- The maximum format length from the widget's @ phrases.void realize()