public class BrowseColumnWidget extends ControlEntity<BrowseColumnConfig> implements AutoReturnElement, AutoZapElement, BrowseColumnInterface, BrowseElement, MaxCharsElement, NumItems, SortedElement, InnerLines, Hoverable, IndexedInterface, WriteProtectable
The LegacyResource
annotation targets the LegacyResource.FILL_IN
type.
The 4GL documentation states that LegacyResource.BROWSE_COLUMN
type is used only when
"-browcoltype" parameter is * at program startup. Else, the type can be either
LegacyResource.FILL_IN
, LegacyResource.COMBO_BOX
or
LegacyResource.TOGGLE_BOX
(depending on the column's widget).
TODO: fix this to report the correct type.
TODO: check if the browse columns can be dynamic; if so, change the c'tor to receive a boolean
flag.
BaseEntity.CharsPixels
Modifier and Type | Field and Description |
---|---|
private int |
bufferIndexInQuery
If the query uses a field reference as the data source, this is the 0-based index of the
related backing buffer in the browsed query.
|
private boolean |
calcColumn
true if it is a calc column. |
private GenericWidget |
editor
Widget which is used for in-browse editing for this column (if the column is editable).
|
private FrameElement |
element
Back reference to the variable accessor.
|
private java.lang.String |
hyperlinkEventName
Name of the event which is raised when a hyperlink is clicked in this column.
|
private java.lang.Class<?> |
linkedDMOInterface
If the query uses a field reference as the data source, this is DMO interface of the
related backing buffer in the browsed query.
|
ALIGN_COLON, ALIGN_LEFT, ALIGN_RIGHT
group
config, deleted, frame
name, nextSibling, prevSibling
instProc
Constructor and Description |
---|
BrowseColumnWidget()
Default constructor creates a static browse column
|
BrowseColumnWidget(boolean dynamic)
Parameterized constructor creates a dynamic browse column.
|
BrowseColumnWidget(boolean dynamic,
boolean isCalcColumn)
Parameterized constructor creates a dynamic browse column.
|
Modifier and Type | Method and Description |
---|---|
handle |
bufferField()
Get the handle of the browse column's BUFFER-FIELD.
|
private void |
errorEditorAttributeNotSettable(java.lang.String attributeName)
Raise error 4052 "<ATTRIBUTE-NAME> is not a setable attribute for <WIDGET-TYPE>
<COLUMN-NAME>".
|
integer |
getBgColor()
Gets the BGCOLOR writable attribute.
|
private BrowseWidget |
getBrowse()
Returns parent browse widget.
|
integer |
getColumnBgColor()
Gets the COLUMN-BGCOLOR writable attribute.
|
integer |
getColumnFgColor()
Gets the COLUMN-FGCOLOR writable attribute.
|
integer |
getColumnFont()
Get the COLUMN-FONT attribute of this browse column widget.
|
logical |
getColumnReadOnly()
Get the COLUMN-READ-ONLY attribute, which indicates whether you can tab to a browse column
but not edit it.
|
integer |
getCursorOffset()
Obtains the index position of the cursor in the edited cell in this column.
|
character |
getDataType()
Queries the DATA-TYPE attribute of this widget.
|
(package private) GenericWidget |
getEditor()
Get widget which is used for in-browse editing for this column.
|
integer |
getFgColor()
Gets the FGCOLOR writable attribute.
|
(package private) FieldReference |
getFieldReference()
Get reference to the associated buffer field.
|
character |
getFormat()
Gets the format specification.
|
character |
getHyperlinkEvent()
Returns the HYPERLINK attribute (FWD extension), which indicates the name of the event which
is raised when a hyperlink from this column is clicked.
|
integer |
getIndex()
Get value of the INDEX attribute: subscript value of the array element referenced by the
current column.
|
integer |
getInnerLines()
Gets the value of the INNER-LINES attribute which defines the number of text lines
in the widget.
|
character |
getLabel()
Get the label text for this widget.
|
integer |
getLabelBgColor()
Gets the LABEL-BGCOLOR writable attribute.
|
integer |
getLabelFgColor()
Gets the LABEL-FGCOLOR writable attribute.
|
integer |
getLabelFont()
Get the LABEL-FONT attribute of this browse column widget.
|
integer |
getMaxChars()
Get value of the MAX-CHARS attribute.
|
java.lang.String |
getMousePointerImpl()
Get the MOUSE-POINTER attribute
|
handle |
getNextColumn()
Implements the NEXT-COLUMN attribute getter.
|
integer |
getNumItems()
Get the NUM-ITEMS attribute.
|
integer |
getSortNumber()
Get the SORT-NUMBER attribute, which indicates the sort-level number for the browse column.
|
BaseDataType |
getValue()
Retrieve value of the associated variable.
|
decimal |
getWidthChars()
Get the WIDTH attribute value.
|
integer |
getWidthPixels()
Queries the WIDTH-PIXELS attribute.
|
logical |
isAutoReturn()
Get value of the AUTO-RETURN attribute.
|
logical |
isAutoZap()
Get value of the AUTO-ZAP attribute.
|
boolean |
isCalcColumn()
Returns
true if it is a calc column. |
logical |
isDisableAutoZap()
Get value of the DISABLE-AUTO-ZAP attribute
|
logical |
isModified()
Queries if the SCREEN-VALUE attribute for this widget was changed.
|
logical |
isReadOnly()
Checks whether the widget is write-protected.
|
logical |
isResizable()
Getter for RESIZABLE attribute.
|
logical |
isSort()
Get value of the SORT attribute.
|
logical |
isSortAscending()
Gets the SORT-ASCENDING attribute, which defines the state of the sort arrow in the column
header.
|
(package private) boolean |
isSortNumberValid(int64 sortNumber)
Check if sort-level number is valid.
|
boolean |
isTabWidget()
This widget can't be a tab item.
|
character |
name()
Gets the widget name.
|
(package private) void |
openHyperlink(java.lang.String hyperlinkText)
Open the hyperlink by raising the event previously set for this column using the HYPERLINK
attribute (FWD extension).
|
(package private) BaseDataType |
screenValueToBDT(character screenValue,
boolean noError)
Convert character screen value to the column's data type.
|
void |
setAutoReturn(boolean autoReturn)
Sets the AUTO-RETURN option.
|
void |
setAutoReturn(logical autoReturn)
Sets the AUTO-RETURN option.
|
void |
setAutoZap(boolean value)
Set AUTO-ZAP attribute.
|
void |
setAutoZap(logical autoZap)
Set value of the AUTO-ZAP attribute.
|
void |
setBgColor(int bgColor)
Sets the BGCOLOR writable attribute.
|
void |
setBgColor(integer bgColor)
Sets the BGCOLOR writable attribute.
|
void |
setBrowseId(int id)
Set ID of the browse widget to which this column belongs.
|
void |
setColumnBgColor(integer bgcolor)
Sets the COLUMN-BGCOLOR writable attribute.
|
void |
setColumnBgColor(long param)
Sets the COLUMN-BGCOLOR writable attribute.
|
void |
setColumnBgColor(NumberType param)
Sets the COLUMN-BGCOLOR writable attribute.
|
void |
setColumnFgColor(long param)
Sets the COLUMN-FGCOLOR writable attribute.
|
void |
setColumnFgColor(NumberType param)
Sets the COLUMN-FGCOLOR writable attribute.
|
void |
setColumnFont(int64 fontNum)
Set the COLUMN-FONT attribute of this browse widget.
|
void |
setColumnLabel(java.lang.String label)
Set the COLUMN-LABEL attribute.
|
void |
setColumnReadOnly(boolean columnReadOnly)
Sets the COLUMN-READ-ONLY attribute, which indicates whether you can tab to a browse column
but not edit it.
|
void |
setColumnReadOnly(logical columnReadOnly)
Sets the COLUMN-READ-ONLY attribute, which indicates whether you can tab to a browse column
but not edit it.
|
void |
setCursorOffset(double offset)
Sets the index position of the cursor in the edited cell in this column.
|
void |
setCursorOffset(NumberType offset)
Sets the index position of the cursor in the edited cell in this column.
|
void |
setDataType(character dataType)
Sets new value of DATA-TYPE attribute.
|
void |
setDataType(java.lang.String value)
Set the DATA-TYPE attribute value.
|
void |
setDColor(Color displayColor)
Sets the display color.
|
void |
setDColor(NumberType param)
Sets the display color.
|
void |
setDisableAutoZap(boolean value)
Set DISABLE-AUTO-ZAP attribute.
|
void |
setDisableAutoZap(logical value)
Set DISABLE-AUTO-ZAP attribute.
|
void |
setEditable(boolean value)
Enable editing of the column.
|
(package private) void |
setEditor(GenericWidget editor)
Set editor widget (fill-in, toggle-box or combo-box) which is used for in-browse editing for
this column.
|
(package private) void |
setElement(FrameElement element,
P2JQuery query)
Provide link to the backing accessor.
|
void |
setFgColor(int fgColor)
Sets the FGCOLOR writable attribute.
|
void |
setFgColor(integer fgColor)
Sets the FGCOLOR writable attribute.
|
void |
setForceLabel(boolean force)
Force presence of the label.
|
void |
setFormatWidth(int value)
Set format width of AT base field.
|
void |
setHyperlinkEvent(character eventName)
Sets the HYPERLINK attribute (FWD extension), which indicates the name of the event which
is raised when a hyperlink from this column is clicked.
|
void |
setHyperlinkEvent(java.lang.String eventName)
Sets the HYPERLINK attribute (FWD extension), which indicates the name of the event which
is raised when a hyperlink from this column is clicked.
|
void |
setInitialInnerLines(double lines)
Sets the value of the INNER-LINES attribute which defines the number of text lines
in the widget.
|
void |
setInnerLines(double lines)
Sets the value of the INNER-LINES attribute which defines the number of text lines
in the widget.
|
void |
setInnerLines(NumberType lines)
Sets the value of the INNER-LINES attribute which defines the number of text lines
in the widget.
|
void |
setLabel(java.lang.String label)
Sets the label text, removing any '&' characters first (this is
an undocumented feature of Progress with labels).
|
void |
setLabelBgColor(int64 bgcolor)
Sets the LABEL-BGCOLOR writable attribute.
|
void |
setLabelBgColor(long bgcolor)
Sets the LABEL-BGCOLOR writable attribute.
|
void |
setLabelFgColor(int64 fgcolor)
Sets the LABEL-FGCOLOR writable attribute.
|
void |
setLabelFgColor(long fgcolor)
Sets the LABEL-FGCOLOR writable attribute.
|
void |
setLabelFont(int64 fontNum)
Set the LABEL-FONT attribute of this browse widget.
|
void |
setLabelFont(long font)
Set the LABEL-FONT attribute of this browse widget.
|
void |
setLabels(boolean labels)
Set LABELS attribute.
|
void |
setMaxChars(double maxChars)
Set value of the MAX-CHARS attribute.
|
void |
setMaxChars(NumberType maxChars)
Set value of the MAX-CHARS 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 |
setMousePointerName(java.lang.String name)
Set the MOUSE-POINTER attribute
|
void |
setNoLabels(boolean nolabels)
Set LABELS attribute as opposite to passed value.
|
void |
setPfColor(Color inputColor)
Sets the input (prompt/edit mode) color.
|
void |
setPfColor(NumberType param)
Sets the input (prompt/edit mode) color.
|
void |
setReadOnly(logical r)
Sets the READ-ONLY attribute of the widget.
|
void |
setResizable(boolean on)
Setter for RESIZABLE attribute.
|
void |
setResizable(logical on)
Setter for RESIZABLE attribute.
|
void |
setScreenValue(character screenValue)
Sets the SCREEN-VALUE writable attribute.
|
void |
setScreenValue(java.lang.String screenValue)
Sets the SCREEN-VALUE writable attribute.
|
logical |
setSelection(int64 start,
int64 end)
Selects text in a widget between start and end points.
|
logical |
setSelection(int64 start,
long end)
Selects text in a widget between start and end points.
|
logical |
setSelection(long start,
int64 end)
Selects text in a widget between start and end points.
|
logical |
setSelection(long start,
long end)
Selects text in a widget between start and end points.
|
void |
setSort(boolean sort)
Set value of the SORT attribute.
|
void |
setSort(logical sort)
Set value of the SORT attribute.
|
void |
setSortAscending(boolean ascending)
Sets the SORT-ASCENDING attribute, which defines the state of the sort arrow in the column
header.
|
void |
setSortAscending(logical ascending)
Sets the SORT-ASCENDING attribute, which defines the state of the sort arrow in the column
header.
|
void |
setSortNumber(int sortNumber)
Sets the SORT-NUMBER attribute, which indicates the sort-level number for the browse column.
|
void |
setSortNumber(int64 sortNumber)
Sets the SORT-NUMBER attribute, which indicates the sort-level number for the browse column.
|
void |
setValidation(ValidationExpr valexp,
java.lang.String valmsg)
Registers callbacks for validation processing (during editing) for any input into this
widget.
|
void |
setValue(BaseDataType value)
Assign value to associated variable.
|
void |
setViewAsToggleBox(boolean value)
Set if this column should be displayed as toggle-box.
|
void |
setVisible(boolean visible)
Mark this column as visible (or not) by setting the VISIBLE attribute.
|
void |
setWidthChars(double value)
Set the WIDTH attribute value.
|
void |
setWidthChars(NumberType value)
Set the WIDTH attribute value.
|
void |
setWidthPixels(int widthPixels)
Sets new value of WIDTH-PIXELS attribute.
|
void |
setWidthPixels(NumberType widthPixels)
Sets new value of WIDTH-PIXELS attribute.
|
(package private) void |
setWidthWorker(BaseEntity.CharsPixels width)
Worker for setting column width.
|
(package private) void |
setWidthWorker(BaseEntity.CharsPixels width,
boolean push)
Worker for setting column width.
|
java.lang.String |
type()
Get the type of this handle as type of String.
|
(package private) boolean |
updateBufferReferences(P2JQuery query)
If this column uses a field reference as the data source, and a new query was assigned (this
query may have different backing buffers which, however, have the same DMO interfaces as in
the original query), update the field reference so that it points to the new buffer.
|
protected logical |
validateFields(boolean enabledOnly)
Processes validation rules (if they exist), error checking and any other constraint
processing that needs to be applied.
|
changeFontWorker, firstChild, getColon, getDataClass, getNextTabItem, getPreviousTabItem, getPrevSibling, getSideLabelHandle, getSizeAttrs, getTitle, hasSideLabelHandle, isAutoResize, isDropTarget, lastChild, processSideLabel, resetAutoResize, setAttrSpace, setAutoResize, setAutoResize, setColumnLabel, setDropTarget, setForceLabel, setHeightCharsWorker, setHeightPixelsWorker, setIndex, setIndex, setNoAttrSpace, setTitle, setTitle, setTo, setTo, setWidthCharsWorker, setWidthPixelsWorker
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, getBgColorRgb, getColumn, getDColor, getFgColorRgb, getFont, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getParent, getPfColor, getRow, getTooltip, getValidParentTypes, getX, getY, isMovable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, setAlign, setBgColor, setBgColorRgb, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setFgColor, setFgColorRgb, setFgColorRgb, setFgColorRgb, setFont, setGroup, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setTabStop, setTabStop, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setX, setX, setXorY, setXOrYWorker, setY, setY, useHandleChainSiblings, validateParent, validateSize, validColumnOrRow
_dynamic, _getDbName, _getFormat, _getTable, _isEntered, _isHidden, _isNotEntered, _isRealized, _isVisible, _setDynamic, _setVisible, afterConfigUpdate, apply, apply, apply, apply, asWidgetHandle, canAccess, canDelete, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, enable, finishConfigProcessing, finishSetup, getColumnLabel, getContextHelpId, getConvert3D, getDbName, getFrame, getFrameHandle, getHelp, getHWND, getId, getImage, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getPopupMenu, getQuery, getRetainShape, getScreenValue, getScreenValue, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, getZOrderClass, hasFormat, hasNameReadOnly, hasParent, hide, hide, implicitDeletion, inputValue, isChained, isChecked, isDisableRedraw, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMultiple, isNotEntered, isScrollable, isSelectable, isSelected, isSelected, isSensitive, isTextSelected, isThreeD, isValidatable, isVisible, labelSizeCheck, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, moveToWorker, notQueryable, notQueryable, notSettable, notSettable, notWorker, preRealizeCheck, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setBlank, setChecked, setChecked, setColumnFont, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setDbname, setDeblank, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHeader, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setPopupMenu, setPopupMenu, setQuery, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSensitive, setSensitive, setSensitive, setSensitive, setSideLabelHandle, setStretchToFit, setStretchToFit, setTable, setThreeD, setThreeD, setTitleFont, setTitleFont, setTransparent, setTransparent, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setVisible, setWidgetId, setWidgetId, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, view, widgetName
delete, firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData
getResourceType, id, id, instantiatingProcedure, invalidAttribute, setInstantiatingProcedure, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget
setScreenValue
getPrivateData, setPrivateData, setPrivateData
getResourceType
id, id, unknown
setDisableRedraw
private FrameElement element
private GenericWidget editor
private java.lang.Class<?> linkedDMOInterface
null
.private int bufferIndexInQuery
-1
.private final boolean calcColumn
true
if it is a calc column.private java.lang.String hyperlinkEventName
PUBLISH eventName (hyperlinkText).
public BrowseColumnWidget()
public BrowseColumnWidget(boolean dynamic)
dynamic
- The true value indicates a dynamic widget will be created, otherwise a static one.public BrowseColumnWidget(boolean dynamic, boolean isCalcColumn)
dynamic
- The true value indicates a dynamic widget will be created, otherwise a static one.isCalcColumn
- true
if it is a calc column.public logical isReadOnly()
isReadOnly
in interface WriteProtectable
true
if the widget is write-protected.public boolean isCalcColumn()
true
if it is a calc column.public void setReadOnly(logical r)
setReadOnly
in interface WriteProtectable
r
- true
if the widget should be write-protected.public integer getInnerLines()
getInnerLines
in interface InnerLines
public void setInitialInnerLines(double lines)
setInitialInnerLines
in interface InnerLines
lines
- The new number of lines.public void setInnerLines(double lines)
setInnerLines
in interface InnerLines
lines
- The new number of lines.public void setInnerLines(NumberType lines)
setInnerLines
in interface InnerLines
lines
- The new number of lines.public logical isModified()
isModified
in interface CommonWidget
isModified
in class ControlEntity<BrowseColumnConfig>
true
, the widget's screen value was changed.public void setModified(logical modified)
setModified
in interface CommonWidget
setModified
in class ControlEntity<BrowseColumnConfig>
modified
- true
to mark the screen value as changed.public void setModified(boolean modified)
setModified
in interface CommonWidget
setModified
in class ControlEntity<BrowseColumnConfig>
modified
- true
to mark the screen value as changed.public void setAutoReturn(logical autoReturn)
setAutoReturn
in interface AutoReturnElement
setAutoReturn
in class GenericWidget<BrowseColumnConfig>
autoReturn
- true
if the option is set to ON.public void setAutoReturn(boolean autoReturn)
setAutoReturn
in interface AutoReturnElement
setAutoReturn
in class GenericWidget<BrowseColumnConfig>
autoReturn
- true
if the option is set to ON.public logical isAutoReturn()
isAutoReturn
in interface AutoReturnElement
isAutoReturn
in class GenericWidget<BrowseColumnConfig>
public void setColumnLabel(java.lang.String label)
setColumnLabel
in interface CommonField
setColumnLabel
in class ControlEntity<BrowseColumnConfig>
label
- The new value for the attribute.public void setLabel(java.lang.String label)
setLabel
in interface CommonField
setLabel
in class GenericWidget<BrowseColumnConfig>
label
- The new label text.public void setDataType(java.lang.String value)
setDataType
in interface CommonField
setDataType
in class ControlEntity<BrowseColumnConfig>
value
- New value for the attribute.public character getDataType()
getDataType
in interface CommonField
getDataType
in class ControlEntity<BrowseColumnConfig>
public void setDataType(character dataType)
setDataType
in interface CommonField
setDataType
in class ControlEntity<BrowseColumnConfig>
dataType
- new value of DATA-TYPE attributepublic void setWidthChars(NumberType value)
setWidthChars
in interface Sizeable
setWidthChars
in class BaseEntity<BrowseColumnConfig>
value
- New value for the attribute.public void setWidthChars(double value)
setWidthChars
in interface Sizeable
setWidthChars
in class BaseEntity<BrowseColumnConfig>
value
- New value for the attribute.public decimal getWidthChars()
getWidthChars
in interface Sizeable
getWidthChars
in class BaseEntity<BrowseColumnConfig>
public integer getWidthPixels()
getWidthPixels
in interface Sizeable
getWidthPixels
in class BaseEntity<BrowseColumnConfig>
public void setWidthPixels(NumberType widthPixels)
setWidthPixels
in interface Sizeable
setWidthPixels
in class BaseEntity<BrowseColumnConfig>
widthPixels
- new value of WIDTH-PIXELS attributepublic void setWidthPixels(int widthPixels)
setWidthPixels
in interface Sizeable
setWidthPixels
in class BaseEntity<BrowseColumnConfig>
widthPixels
- new value of WIDTH-PIXELS attributepublic void setFormatWidth(int value)
value
- New format width.public void setEditable(boolean value)
value
- New value for the attribute.public void setAutoZap(boolean value)
setAutoZap
in interface AutoZapElement
value
- New value for the attribute.public void setLabels(boolean labels)
labels
- New value for the attribute.public void setNoLabels(boolean nolabels)
setNoLabels
in class ControlEntity<BrowseColumnConfig>
nolabels
- New value for the attribute.public void setForceLabel(boolean force)
setForceLabel
in class ControlEntity<BrowseColumnConfig>
force
- New value for the flag.public java.lang.String type()
type
in class HandleResource
public void setValidation(ValidationExpr valexp, java.lang.String valmsg)
setValidation
in interface CommonWidget
setValidation
in class GenericWidget<BrowseColumnConfig>
valexp
- The Function
to call to determine if the edits are allowed.valmsg
- The error message on a validation failure.void setElement(FrameElement element, P2JQuery query)
element
- The accessor for this column.query
- Backing browsed query.java.lang.IllegalArgumentException
- if the browsed query is null
.boolean updateBufferReferences(P2JQuery query)
query
- New assigned query.true
if the field reference was successfully updated or if this column
doesn't use a field reference as the data source. false
if the
reference cannot be updated because the new query users buffer of a different
DMO interface.public BaseDataType getValue()
public void setValue(BaseDataType value)
value
- New value for the variable.public void setBrowseId(int id)
id
- Browse ID.public integer getColumnFont()
getColumnFont
in interface CommonWidget
getColumnFont
in class GenericWidget<BrowseColumnConfig>
public void setColumnFont(int64 fontNum)
setColumnFont
in interface CommonWidget
setColumnFont
in class GenericWidget<BrowseColumnConfig>
fontNum
- An entry in the font-table or unknown to refer the default font.public integer getLabelFont()
getLabelFont
in interface BrowseElement
getLabelFont
in interface CommonWidget
getLabelFont
in class GenericWidget<BrowseColumnConfig>
public void setLabelFont(long font)
setLabelFont
in interface BrowseElement
setLabelFont
in interface CommonWidget
setLabelFont
in class GenericWidget<BrowseColumnConfig>
font
- An entry in the font-table or unknown to refer the default font.public void setLabelFont(int64 fontNum)
setLabelFont
in interface BrowseElement
setLabelFont
in interface CommonWidget
setLabelFont
in class GenericWidget<BrowseColumnConfig>
fontNum
- An entry in the font-table or unknown to refer the default font.public void setPfColor(NumberType param)
setPfColor
in interface CommonWidget
setPfColor
in class BaseEntity<BrowseColumnConfig>
param
- The color to use.public void setPfColor(Color inputColor)
setPfColor
in interface CommonWidget
setPfColor
in class BaseEntity<BrowseColumnConfig>
inputColor
- The color to use for when in "input" mode.public void setDColor(NumberType param)
setDColor
in interface CommonWidget
setDColor
in class BaseEntity<BrowseColumnConfig>
param
- The display color.public void setDColor(Color displayColor)
setDColor
in interface CommonWidget
setDColor
in class BaseEntity<BrowseColumnConfig>
displayColor
- The display color.public integer getBgColor()
getBgColor
in interface CommonWidget
getBgColor
in class BaseEntity<BrowseColumnConfig>
public void setBgColor(integer bgColor)
setBgColor
in interface CommonWidget
setBgColor
in class BaseEntity<BrowseColumnConfig>
bgColor
- The new value for the BGCOLOR attribute.public void setBgColor(int bgColor)
setBgColor
in class BaseEntity<BrowseColumnConfig>
bgColor
- The new value for the BGCOLOR attribute.public integer getFgColor()
getFgColor
in interface CommonWidget
getFgColor
in class BaseEntity<BrowseColumnConfig>
public void setFgColor(integer fgColor)
setFgColor
in interface CommonWidget
setFgColor
in class BaseEntity<BrowseColumnConfig>
fgColor
- The new value for the FGCOLOR attribute.public void setFgColor(int fgColor)
setFgColor
in class BaseEntity<BrowseColumnConfig>
fgColor
- The new value for the FGCOLOR attribute.public void setScreenValue(character screenValue)
setScreenValue
in interface CommonWidget
setScreenValue
in class GenericWidget<BrowseColumnConfig>
screenValue
- The new value for the SCREEN-VALUE attribute.public void setScreenValue(java.lang.String screenValue)
screenValue
- The new value for the SCREEN-VALUE attribute.public void setColumnBgColor(NumberType param)
setColumnBgColor
in interface BrowseColumnInterface
param
- The new value for the COLUMN-BGCOLOR attribute.public void setColumnBgColor(long param)
setColumnBgColor
in interface BrowseColumnInterface
param
- The new value for the COLUMN-BGCOLOR attribute.public void setColumnFgColor(NumberType param)
setColumnFgColor
in interface BrowseColumnInterface
param
- The new value for the COLUMN-FGCOLOR attribute.public void setColumnFgColor(long param)
setColumnFgColor
in interface BrowseColumnInterface
param
- The new value for the COLUMN-FGCOLOR attribute.public integer getNumItems()
getNumItems
in interface NumItems
public handle getNextColumn()
getNextColumn
in interface BrowseColumnInterface
public integer getColumnBgColor()
getColumnBgColor
in interface BrowseColumnInterface
public integer getColumnFgColor()
getColumnFgColor
in interface BrowseColumnInterface
public void setColumnBgColor(integer bgcolor)
bgcolor
- The new value for the BGCOLOR attribute.public integer getLabelBgColor()
getLabelBgColor
in interface BrowseElement
public integer getLabelFgColor()
getLabelFgColor
in interface BrowseElement
public void setLabelBgColor(int64 bgcolor)
setLabelBgColor
in interface BrowseElement
bgcolor
- The new value for the LABEL-BGCOLOR attribute.public void setLabelBgColor(long bgcolor)
setLabelBgColor
in interface BrowseElement
bgcolor
- The new value for the LABEL-BGCOLOR attribute.public void setLabelFgColor(int64 fgcolor)
setLabelFgColor
in interface BrowseElement
fgcolor
- The new value for the LABEL-FGCOLOR attribute.public void setLabelFgColor(long fgcolor)
setLabelFgColor
in interface BrowseElement
fgcolor
- The new value for the LABEL-FGCOLOR attribute.public void setSort(boolean sort)
setSort
in interface SortedElement
sort
- true
if the combo-box browse columns has sorted items.public void setSort(logical sort)
setSort
in interface SortedElement
sort
- true
if the combo-box browse columns has sorted items.public logical isSort()
isSort
in interface SortedElement
true
if the combo-box browse columns has sorted items.public logical setSelection(int64 start, int64 end)
start
- Starting offset.end
- Ending offset.true
if the operation succeeded.public logical setSelection(int64 start, long end)
start
- Starting offset.end
- Ending offset.true
if the operation succeeded.public logical setSelection(long start, int64 end)
start
- Starting offset.end
- Ending offset.true
if the operation succeeded.public logical setSelection(long start, long end)
start
- Starting offset.end
- Ending offset.true
if the operation succeeded.public integer getCursorOffset()
getCursorOffset
in interface CommonWidget
getCursorOffset
in class GenericWidget<BrowseColumnConfig>
public void setCursorOffset(double offset)
setCursorOffset
in interface CommonWidget
setCursorOffset
in class GenericWidget<BrowseColumnConfig>
offset
- The character index at which the cursor is to be placed.public void setCursorOffset(NumberType offset)
setCursorOffset
in interface CommonWidget
setCursorOffset
in class GenericWidget<BrowseColumnConfig>
offset
- The character index at which the cursor is to be placed.public void setMaxChars(double maxChars)
setMaxChars
in interface MaxCharsElement
maxChars
- Value of the attribute.public void setMaxChars(NumberType maxChars)
setMaxChars
in interface MaxCharsElement
maxChars
- Value of the attribute.public integer getMaxChars()
getMaxChars
in interface MaxCharsElement
public void setAutoZap(logical autoZap)
setAutoZap
in interface AutoZapElement
autoZap
- Value of the attribute.public logical isAutoZap()
isAutoZap
in interface AutoZapElement
public void setDisableAutoZap(boolean value)
setDisableAutoZap
in interface AutoZapElement
setDisableAutoZap
in interface CommonWidget
setDisableAutoZap
in class GenericWidget<BrowseColumnConfig>
value
- New value for the attribute.public void setDisableAutoZap(logical value)
setDisableAutoZap
in interface AutoZapElement
value
- New value for the attribute.public logical isDisableAutoZap()
isDisableAutoZap
in interface AutoZapElement
public void setMousePointerName(java.lang.String name)
setMousePointerName
in interface Hoverable
name
- the attribute valuepublic java.lang.String getMousePointerImpl()
getMousePointerImpl
in interface Hoverable
public character name()
name
in interface Nameable
name
in class GenericWidget<BrowseColumnConfig>
public logical isResizable()
isResizable
in interface CommonWidget
isResizable
in class BaseEntity<BrowseColumnConfig>
true
if widget is resizable.public void setResizable(boolean on)
setResizable
in interface CommonWidget
setResizable
in class BaseEntity<BrowseColumnConfig>
on
- true
to make the widget resizablepublic void setResizable(logical on)
setResizable
in interface CommonWidget
setResizable
in class BaseEntity<BrowseColumnConfig>
on
- true
to make the widget resizablepublic character getFormat()
getFormat
in interface CommonField
getFormat
in class GenericWidget<BrowseColumnConfig>
public void setSortAscending(logical ascending)
setSortAscending
in interface BrowseColumnInterface
ascending
- The new value for the SORT-ASCENDING attribute. Unknown value to hide the arrow,
true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).public void setSortAscending(boolean ascending)
setSortAscending
in interface BrowseColumnInterface
ascending
- The new value for the SORT-ASCENDING attribute. Unknown value to hide the arrow,
true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).public logical isSortAscending()
isSortAscending
in interface BrowseColumnInterface
true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).public void setSortNumber(int64 sortNumber)
setSortNumber
in interface BrowseColumnInterface
sortNumber
- The new value for the SORT-NUMBER attribute. Unknown or 0
to hide the
sort-level number, otherwise numbers from 1
to 9
are
allowed.public void setSortNumber(int sortNumber)
setSortNumber
in interface BrowseColumnInterface
sortNumber
- The new value for the SORT-NUMBER attribute. Unknown or 0
to hide the
sort-level number, otherwise numbers from 1
to 9
are
allowed.public integer getSortNumber()
getSortNumber
in interface BrowseColumnInterface
public character getLabel()
getLabel
in interface CommonField
getLabel
in class GenericWidget<BrowseColumnConfig>
public integer getIndex()
0
.getIndex
in interface IndexedInterface
getIndex
in class ControlEntity<BrowseColumnConfig>
public void setColumnReadOnly(logical columnReadOnly)
setColumnReadOnly
in interface BrowseColumnInterface
columnReadOnly
- The new value for the COLUMN-READ-ONLY attribute. true
if you can tab
to a browse column but not edit it.public void setColumnReadOnly(boolean columnReadOnly)
setColumnReadOnly
in interface BrowseColumnInterface
columnReadOnly
- The new value for the COLUMN-READ-ONLY attribute. true
if you can tab
to a browse column but not edit it.public logical getColumnReadOnly()
getColumnReadOnly
in interface BrowseColumnInterface
public handle bufferField()
bufferField
in interface BrowseColumnInterface
public void setViewAsToggleBox(boolean value)
value
- true
to view boolean column as toggle-box.public void setVisible(boolean visible)
setVisible
in interface CommonWidget
setVisible
in class GenericWidget<BrowseColumnConfig>
visible
- The new value for the VISIBLE attribute.public boolean isTabWidget()
isTabWidget
in class GenericWidget<BrowseColumnConfig>
public void setHyperlinkEvent(java.lang.String eventName)
setHyperlinkEvent
in interface BrowseColumnInterface
eventName
- The name of the event which is raised when a hyperlink from this column is
clicked. null
do disable hyperlinks for this column.public void setHyperlinkEvent(character eventName)
setHyperlinkEvent
in interface BrowseColumnInterface
eventName
- The name of the event which is raised when a hyperlink from this column is
clicked. null
do disable hyperlinks for this column.public character getHyperlinkEvent()
getHyperlinkEvent
in interface BrowseColumnInterface
null
if this is not a hyperlinked column.void openHyperlink(java.lang.String hyperlinkText)
hyperlinkText
is used as the event parameter. I.e.
opening of a hyperlink is an equivalent of
PUBLISH eventName (hyperlinkText).
hyperlinkText
- Text of the hyperlink to be opened.void setEditor(GenericWidget editor)
editor
- Editor widget (fill-in, toggle-box or combo-box) which is used for in-browse editing
for this column.FieldReference getFieldReference()
null
is returned.boolean isSortNumberValid(int64 sortNumber)
sortNumber
- Sort-level number to check.true
if sort-level number is valid.GenericWidget getEditor()
null
if
the column is not editable.BaseDataType screenValueToBDT(character screenValue, boolean noError)
screenValue
- Character screen value to convert.noError
- true
if any errorsvoid setWidthWorker(BaseEntity.CharsPixels width)
width
- New column width in char and pixel units.void setWidthWorker(BaseEntity.CharsPixels width, boolean push)
width
- New column width in char and pixel units.push
- true
if WIDTH-* attributes are immediately pushed to the client side.protected logical validateFields(boolean enabledOnly)
validateFields
in class ControlEntity<BrowseColumnConfig>
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.private BrowseWidget getBrowse()
private void errorEditorAttributeNotSettable(java.lang.String attributeName)
attributeName
- Attribute name.