public class BrowseColumnWidget extends ControlSetEntity<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.
ControlSetEntity.BiPredicate<T,U>
BaseEntity.CharsPixels
Modifier and Type | Field and Description |
---|---|
private boolean |
baseEnhancedFilteringValue
Value of
ENHANCED-FILTERING attribute that has been explicitly assigned. |
private boolean |
baseEnhancedSortingValue
Value of
ENHANCED-SORTING attribute that has been explicitly assigned. |
private BrowseWidget |
browse
The parent browse.
|
private boolean |
calcColumn
true if it is a calc column. |
private boolean |
comboBoxListMode
Defines combo-box mode for combo-box columns.
|
private GenericWidget<?> |
editor
Widget which is used for in-browse editing for this column (if the column is editable).
|
private java.lang.String |
ehDbFilterFieldMapping
For enhanced filtering: name of data field, which this column is
filtered by.
|
private java.lang.String |
ehDbSortFieldMapping
For enhanced sorting: name of data field, which this column is
sorted by.
|
private FieldReference |
ehFilterField
Field reference for the field specified by
ehDbFilterFieldMapping . |
private FieldReference |
ehSortField
Field reference for the field specified by
ehDbSortFieldMapping . |
private FrameElement |
element
Back reference to the variable accessor.
|
private boolean |
hasOverride
Defines if the column is overridden in DEFINE BROWSE statement (e.g.
|
private java.lang.String |
hyperlinkEventName
Name of the event which is raised when a hyperlink is clicked in this column.
|
private static java.util.logging.Logger |
LOG
Logger.
|
private DisplayFormat |
overrideFormat
If the column is overridden in DEFINE BROWSE statement (e.g.
|
COMPARE_LABEL, COMPARE_LABEL_IGNORE_CASE, COMPARE_VALUE_IGNORE_CASE, LTRIM, RTRIM
ALIGN_COLON, ALIGN_LEFT, ALIGN_RIGHT
group
config, deleted, frame, internalScreenValueUsage, realizeOnAttributeAccess
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 boolean |
checkIfComboBox(java.lang.String attributeName)
Checks if the column is a combo-box column.
|
logical |
delete(character item)
Implements the DELETE() widget method, which removes the list item or items specified.
|
logical |
delete(java.lang.String item)
Implements the DELETE() widget method, which removes the list item or items specified.
|
private void |
errorEditorAttributeNotSettable(java.lang.String attributeName)
Raise error 4052 "<ATTRIBUTE-NAME> is not a setable attribute for <WIDGET-TYPE>
<COLUMN-NAME>".
|
character |
getAlignment()
Returns the actual column text alignment.
|
integer |
getBgColor()
Gets the BGCOLOR writable attribute.
|
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.
|
FieldReference |
getDbFilterField()
Get reference to the field specified by
DB-FILTER-FIELD-MAPPING attribute: data field,
which this column is filtered by. |
character |
getDbFilterFieldMapping()
Implements the DB-FILTER-FIELD-MAPPING attribute getter.
|
FieldReference |
getDbSortField()
Get reference to the field specified by DB-SORT-FIELD-MAPPING attribute: data field, which this column
is sorted by.
|
character |
getDbSortFieldMapping()
Implements the DB-SORT-FIELD-MAPPING attribute getter.
|
(package private) GenericWidget<?> |
getEditor()
Get widget which is used for in-browse editing for this column.
|
(package private) FieldReference[] |
getExpressionFieldReferences()
Get array of references to the associated buffer fields.
|
integer |
getFgColor()
Gets the FGCOLOR writable attribute.
|
(package private) FieldReference |
getFieldReference()
Get reference to the associated buffer field.
|
private FieldReference |
getFieldReference(java.lang.String fullFieldName,
java.lang.String actionName)
Find the field of a buffer participating in the browsed query, by the field name.
|
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.
|
DisplayFormat |
getOverrideFormat(BaseDataType value)
If the column is overridden in DEFINE BROWSE statement (e.g.
|
CommonWidget |
getParent()
Gets the PARENT writable attribute.
|
RecordBuffer |
getParentBuffer()
Gets the parent buffer of a buffer-field.
|
handle |
getPopupMenu()
Get widget POPUP-MENU.
|
handle |
getPrevColumn()
Implements the PREV-COLUMN attribute getter.
|
character |
getScreenValue()
Gets the SCREEN-VALUE.
|
(package private) character |
getScreenValue(boolean initialized,
BaseDataType bdt,
java.lang.String fmt,
boolean ignoreFormat)
Internal worker for getting the SCREEN-VALUE on a per-widget basis.
|
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.
|
integer |
getY()
Gets the Y attribute.
|
boolean |
hasOverride()
Returns
true if the column is overridden in DEFINE BROWSE statement (e.g. |
logical |
isAutoCompletion()
Get AUTO-COMPLETION attribute value.
|
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
|
(package private) boolean |
isDropDownList()
Returns combo-box mode for combo-box columns.
|
logical |
isEnhancedFiltering()
Get the value of the ENHANCED-FILTERING attribute.
|
logical |
isEnhancedSorting()
Get the value of the ENHANCED-SORTING attribute.
|
private boolean |
isLastVisibleColumn()
Checks if the column is a last visible column in browse widget.
|
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.
|
protected boolean |
isValidScreenValue(character value)
Check if the tested value is valid for SCREEN-VALUE.
|
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 |
setAlignment(character alignment)
Sets ALIGNMENT attribute (FWD extension), which controls the column text alignment.
|
void |
setAlignment(java.lang.String alignment)
Sets ALIGNMENT attribute (FWD extension), which controls the column text alignment.
|
void |
setAutoCompletion(boolean autoCompletion)
Set AUTO-COMPLETION attribute value.
|
void |
setAutoCompletion(logical autoCompletion)
Set AUTO-COMPLETION attribute value.
|
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(NumberType bgColor)
Sets the BGCOLOR writable attribute.
|
private void |
setBgColorInt(NumberType 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 |
setDbFilterFieldMapping(character fieldMapping)
Implements the DB-FILTER-FIELD-MAPPING attribute setter.
|
void |
setDbFilterFieldMapping(java.lang.String fieldMapping)
Implements the DB-FILTER-FIELD-MAPPING attribute setter.
|
void |
setDbSortFieldMapping(character fieldMapping)
Implements the DB-SORT-FIELD-MAPPING attribute setter.
|
void |
setDbSortFieldMapping(java.lang.String fieldMapping)
Implements the DB-SORT-FIELD-MAPPING attribute setter.
|
void |
setDColor(Color displayColor)
Sets the display color.
|
void |
setDColor(NumberType param)
Sets the display color.
|
private void |
setDColorInt(Color displayColor)
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)
Provide link to the backing accessor.
|
void |
setEnhancedFiltering(boolean filtering)
Sets ENHANCED-FILTERING attribute.
|
void |
setEnhancedFiltering(logical filtering)
Sets ENHANCED-FILTERING attribute.
|
void |
setEnhancedSorting(boolean sorting)
Sets ENHANCED-SORTING attribute.
|
void |
setEnhancedSorting(logical sorting)
Sets ENHANCED-SORTING attribute.
|
void |
setFgColor(int fgColor)
Sets the FGCOLOR writable attribute.
|
void |
setFgColor(NumberType fgColor)
Sets the FGCOLOR writable attribute.
|
private void |
setFgColorInt(NumberType fgColor)
Sets the FGCOLOR writable attribute.
|
void |
setFont(int64 fontNum)
Set the FONT attribute of this widget.
|
void |
setForceLabel(boolean force)
Force presence of the label.
|
void |
setFormatWidth(int value)
Set format width of AT base field.
|
void |
setHonorFormat(boolean b)
For combo-box columns: tell widget that data format should be honored.
|
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.
|
protected void |
setItems(ControlSetItem[] items,
java.lang.Boolean pairs,
boolean checkItems,
java.util.List<ControlSetItem> newAddedItems)
For combo-box columns: store array of items into config.
|
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.
|
protected void |
setListItemPairsWorker(character list,
boolean initScreenValue)
For combo-box columns: common implementation list item pair attributes (LIST-ITEM-PAIRS and
RADIO-BUTTONS) attribute.
|
void |
setMaxChars(double maxChars)
Set value of the MAX-CHARS attribute.
|
void |
setMaxChars(NumberType maxChars)
Set value of the MAX-CHARS attribute.
|
void |
setModeDropDown()
Set DROP-DOWN mode for the combo-box column.
|
void |
setModeDropDownList()
Set DROP-DOWN-LIST mode for the combo-box column.
|
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 |
setNoEnhancedFiltering(boolean noFiltering)
Sets NO-ENHANCED-FILTERING option.
|
void |
setNoEnhancedSorting(boolean noSorting)
Sets NO-ENHANCED-SORTING option.
|
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 |
setPopupMenu(handle menu)
Set widget POPUP-MENU.
|
void |
setPopupMenu(MenuWidget menu)
Set widget POPUP-MENU.
|
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.
|
protected void |
setScreenValueInt(character 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 |
setViewAsComboBox()
Set the type of this column to COMBO-BOX.
|
void |
setViewAsToggleBox()
Set the type of this column to 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.
|
private void |
updateEffectiveEnhancedFiltering()
Update effective value of
ENHANCED-FILTERING attribute. |
private void |
updateEffectiveEnhancedSorting()
Update effective value of
ENHANCED-SORTING attribute. |
(package private) void |
updateElementAccessor(Accessor accessor)
Update backing accessor for this column (if an accessor was previously set).
|
(package private) void |
updateExpressionFieldReferences(FieldReference[] refs)
If this column is backed by an expression containing field references, set new references for this
expression.
|
protected logical |
validateFields(boolean enabledOnly)
Processes validation rules (if they exist), error checking and any other constraint
processing that needs to be applied.
|
add, add, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addFirst, addLast, addLast, addLast, addLast, addLast, addLast, checkIfNotPairs, checkValue, controlSetItem, delete, delete, delete, delete, delete, entry, entry, getDelimiter, getItemIndex, getListItemPairs, getListItems, ignore, ignore, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, insert, invalid, isExpandLabel, isValidScreenValue, itemIndex, lookup, lookup, pairs, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, replace, resolveFormat, setDelimiter, setDelimiter, setItems, setListItemPairs, setListItemPairs, setListItems, setListItems, setScreenValue, truncateValue, truncateValue, truncateValues, useListItemPairs, useListItems, validateScreenValue
changeFontWorker, delete, firstChild, getColon, getDataClass, getNextTabItem, getPreviousTabItem, getPrevSibling, getSideLabelHandleWorker, getSizeAttrs, getTitle, hasSideLabelHandle, isAutoResize, isDropTarget, lastChild, processSideLabel, resetAutoResize, setAttrSpace, setAutoResize, setAutoResize, setColumnLabel, setDropTarget, setForceLabel, setHeightCharsWorker, setHeightPixelsWorker, setIndex, setIndex, setNoAttrSpace, setSideLabelHandleWorker, setTitle, setTitle, setTo, setTo, setWidthCharsWorker, setWidthPixelsWorker
_getHeightChars, _getHeightPixels, _getWidthChars, _getWidthPixels, canSetPixelPositionInChui, emit4084Warning, emitUnableToAssignUnknownAttributeWarning, getBgColorRgb, getColumn, getDColor, getFgColorRgb, getFont, getFontInfo, getFontName, getFontSize, getFrameColumn, getFrameRow, getFrameX, getFrameY, getHeightChars, getHeightPixels, getNextSibling, getParent, getPfColor, getRow, getTooltip, getValidParentTypes, getX, isFontBold, isFontItalic, isFontUnderline, isMovable, isSelected, isTabStop, prepareSizeChars, prepareSizePixels, pushLocAttrs, pushSizeAttrs, setAlign, setBgColor, setBgColorRgb, setBgColorRgb, setColon, setColon, setColumn, setColumn, setColumnOrRow, setColumnOrRowWorker, setDColor, setFgColor, setFgColorRgb, setFgColorRgb, setFontBold, setFontItalic, setFontName, setFontSize, setFontUnderline, setGroup, setHeightChars, setHeightChars, setHeightImpl, setHeightPixels, setHeightPixels, setMaxHeightCharsWorker, setMaxHeightPixelsWorker, setMaxWidthCharsWorker, setMaxWidthPixelsWorker, setMinHeightCharsWorker, setMinHeightPixelsWorker, setMinWidthCharsWorker, setMinWidthPixelsWorker, setMovable, setMovable, setParent, setPfColor, setRow, setRow, setSelected, setSelected, setSizeChars, setSizePixels, setSystemParent, setTabStop, setTabStop, setTooltip, setTooltip, setVirtHeightCharsWorker, setVirtHeightPixelsWorker, setVirtWidthCharsWorker, setVirtWidthPixelsWorker, setWidthImpl, 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, canPushWidgetAttr, cleanup, colorDisplay, colorPrompt, config, deselectRows, detachMenu, disable, dynamic, editUndo, enable, finishConfigProcessing, finishSetup, flushWidgetAttrs, genAssignUnknownWarning, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getAttr, getColumnLabel, getContextHelpId, getConvert3D, getDbName, getFrame, getFrameHandle, getFrameName, getHeight, getHelp, getHWND, getId, getImage, getLabelStr, getLogicalTerminal, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNumColumns, getNumSelectedRows, getParentHandle, getQuery, getRetainShape, getSideLabelHandle, getStretchToFit, getTable, getTabPosition, getTitleFont, getTransparent, getValidationExpression, getValidationMessage, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWidth, 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, openPopup, preRealizeCheck, pushScreenDefinition, pushWidgetAttr, pushWidgetAttr, readOnlyError, readOnlyError, realize, refresh, resourceDelete, restoreSharedState, saveSharedState, selectAll, selectFocusedRow, setAtFormatLength, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttr, setAttrs, setBlank, setChecked, setChecked, setColumnFont, setContextHelpId, setContextHelpId, setConvert3D, setConvert3D, setDbname, setDeblank, setDisableRedraw, setFont, setFormat, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setHeader, setHeight, setHelp, setHelp, setHelpDefault, setHelpStatic, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setLabel, setLabel, setLabelInt, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setMultiple, setMultiple, setNextTabItem, setNoAutoValidate, setNumSelectedRows, setParentHandle, setParentHandle, setQuery, setReadOnly, setRetainShape, setRetainShape, setScreenLock, setScreenValue, setScreenValue, setScreenValueNoErrorHandling, 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, setWidth, truncatePixelSize, underline, underline, valid, validate, validateFields, validateFields, validateFields, validateLabelAssignment, view, warningAlreadyRealized, widgetName
firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNameConstraints, hasNextSibling, hasPrevSibling, hasPrivateData, interlink, lastResource, lastResource, moveInChain, name, name, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName
doDelete, getResourceType, id, id, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, setInstantiatingProcedure, toString, unableToAssignUnknown, unknown
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
apply, apply, apply, apply, asWidgetHandle, colorDisplay, colorPrompt, deselectRows, disable, editUndo, enable, getBgColorRgb, getContextHelpId, getDColor, getFgColorRgb, getFont, getFrame, getFrameColumn, getFrameHandle, getFrameName, getFrameRow, getFrameX, getFrameY, getHWND, getId, getIdEx, getImage, getLabelStr, getMaxHeightChars, getMaxWidthChars, getMenuKey, getMenuMouse, getMousePointer, getMousePosition, getNextTabItem, getNumColumns, getNumSelectedRows, getParentHandle, getPfColor, getPreviousTabItem, getQuery, getSideLabelHandle, getTabPosition, getTitle, getTitleFont, getTooltip, getVirtHeight, getVirtHeightPixels, getVirtWidth, getVirtWidthPixels, getWidgetId, getWindow, hide, hide, inputValue, isAutoResize, isEditCanUndo, isEntered, isFocusedRowSelected, isHidden, isKeepFrameZOrder, isManualHighlight, isMovable, isMultiple, isNotEntered, isScrollable, isSelectable, isSelected, isSelected, isSelected, isTabStop, isThreeD, isValidatable, loadMousePointer, loadMousePointer, moveAfterTab, moveAfterTab, moveBeforeTabItem, moveBeforeTabItem, moveToBottom, moveToTop, openPopup, preRealizeCheck, realize, refresh, selectAll, selectFocusedRow, setAtFormatLength, setAutoResize, setAutoResize, setBgColorRgb, setBlank, setColumnFont, setContextHelpId, setContextHelpId, setDeblank, setFgColorRgb, setFont, setFormat, setFrame, setFrame, setFrame, setFrameHandle, setFrameHandle, setFrameHandle, setGroup, setHeader, setHidden, setHidden, setId, setKeepFrameZOrder, setKeepFrameZOrder, setManualHighlight, setManualHighlight, setMaxHeightChars, setMaxWidthChars, setMenuKey, setMenuKey, setMenuMouse, setMenuMouse, setMovable, setMovable, setMultiple, setMultiple, setNextTabItem, setNumSelectedRows, setParent, setParentHandle, setParentHandle, setQuery, setReadOnly, setScreenValue, setScreenValue, setScrollable, setScrollable, setSelectable, setSelectable, setSelected, setSelected, setSensitive, setSideLabelHandle, setTabStop, setTabStop, setThreeD, setThreeD, setTitle, setTitle, setTitleFont, setTitleFont, setTooltip, setTooltip, setValidation, setVertical, setVirtHeight, setVirtHeightPixels, setVirtWidth, setVirtWidthPixels, setWidgetId, setWidgetId, underline, underline, valid, validateFields, validateFields, validateFields, view
getNextSibling, getPrevSibling, getPrivateData, setPrivateData, setPrivateData
getResourceType, readOnlyError, readOnlyError
id, id, unknown
getColumnLabel, getHelp, setColumnLabel, setFormat, setHelp, setHelp, setLabel, setLabel
getDbName, getTable
isDisableRedraw, setDisableRedraw, setDisableRedraw
isVisible, setVisible
getHeight, getHeightChars, getHeightPixels, getWidth, setHeight, setHeightChars, setHeightChars, setHeightPixels, setHeightPixels, setWidth
getColumn, getRow, getX, setColumn, setColumn, setRow, setRow, setX, setX, setY, setY
getRetainShape, getStretchToFit, getTransparent, setRetainShape, setRetainShape, setStretchToFit, setStretchToFit, setTransparent, setTransparent
getConvert3D, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, loadImage, setConvert3D, setConvert3D
replace, replace, replace, replace, replace, replace, replace, replace
endFileDrop, getDroppedFile, getDroppedFile, getNumDroppedFiles, setDropTarget
private static final java.util.logging.Logger LOG
private FrameElement element
private GenericWidget<?> editor
private final boolean calcColumn
true
if it is a calc column.private java.lang.String hyperlinkEventName
PUBLISH eventName (hyperlinkText).
private boolean comboBoxListMode
true
for
DROP-DOWN-LIST
, false
for DROP-DOWN
.private java.lang.String ehDbSortFieldMapping
For enhanced sorting: name of data field, which this column is sorted by. This attribute is used for the case when the field which backs the current column is only a visual representation of data, while the actual data is another field from the browsed query or an expression containing fields from the browsed query.
E.g. consider the current column is bound to a character
field with an arbitrary
formatted date, like "7 Nov 2021", while the field containing the date
itself is not
visible in browse, but reachable from the browsed query. The displayed data in this column is
sorted by the last (date
) field.
private FieldReference ehSortField
ehDbSortFieldMapping
.private java.lang.String ehDbFilterFieldMapping
For enhanced filtering: name of data field, which this column is filtered by. This attribute is used for the case when the field which backs the current column is only a visual representation of data, while the actual data is another field from the browsed query or an expression containing fields from the browsed query.
E.g. consider the current column is bound to a character
field with an arbitrary
formatted date, like "7 Nov 2021", while the field containing the date
itself is not
visible in browse, but reachable from the browsed query. The displayed data in this column is
filtered by the last (date
) field.
private FieldReference ehFilterField
ehDbFilterFieldMapping
.private BrowseWidget browse
private boolean baseEnhancedSortingValue
ENHANCED-SORTING
attribute that has been explicitly assigned. The effective value
of this attribute may differ from the assigned value, depending on the type of data backing the column
and if the column is mapped.private boolean baseEnhancedFilteringValue
ENHANCED-FILTERING
attribute that has been explicitly assigned. The effective value
of this attribute may differ from the assigned value, depending on the type of data backing the column
and if the column is mapped.private boolean hasOverride
private DisplayFormat overrideFormat
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 handle getPopupMenu()
getPopupMenu
in interface CommonWidget
getPopupMenu
in class GenericWidget<BrowseColumnConfig>
public void setPopupMenu(handle menu)
setPopupMenu
in interface CommonWidget
setPopupMenu
in class GenericWidget<BrowseColumnConfig>
menu
- The pop-up menu handle.public void setPopupMenu(MenuWidget menu)
setPopupMenu
in interface CommonWidget
setPopupMenu
in class GenericWidget<BrowseColumnConfig>
menu
- The pop-up menu widget.public boolean isCalcColumn()
true
if it is a calc column.public void setReadOnly(logical r)
setReadOnly
in interface CommonWidget
setReadOnly
in interface WriteProtectable
setReadOnly
in class GenericWidget<BrowseColumnConfig>
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 setAutoCompletion(logical autoCompletion)
setAutoCompletion
in interface CommonWidget
setAutoCompletion
in class GenericWidget<BrowseColumnConfig>
autoCompletion
- New value for the attribute.public CommonWidget getParent()
getParent
in interface CommonWidget
getParent
in class BaseEntity<BrowseColumnConfig>
public RecordBuffer getParentBuffer()
public void setAutoCompletion(boolean autoCompletion)
setAutoCompletion
in interface CommonWidget
setAutoCompletion
in class GenericWidget<BrowseColumnConfig>
autoCompletion
- New value for the attribute.public logical isAutoCompletion()
isAutoCompletion
in interface CommonWidget
isAutoCompletion
in class GenericWidget<BrowseColumnConfig>
public 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.public integer getY()
getY
in interface Coordinates
getY
in class BaseEntity<BrowseColumnConfig>
void setElement(FrameElement element)
element
- The accessor for this column.java.lang.IllegalArgumentException
- if the browsed query is null
.void updateElementAccessor(Accessor accessor)
accessor
- New accessor to set.void updateExpressionFieldReferences(FieldReference[] refs)
refs
- New field references to set.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(NumberType 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(NumberType fgColor)
setFgColor
in interface CommonWidget
setFgColor
in class BaseEntity<BrowseColumnConfig>
fgColor
- The new value for the FGCOLOR attribute.public void setFont(int64 fontNum)
setFont
in interface CommonWidget
setFont
in class BaseEntity<BrowseColumnConfig>
fontNum
- An entry in the font-table or unknown to refer the default font.public void setFgColor(int fgColor)
setFgColor
in class BaseEntity<BrowseColumnConfig>
fgColor
- The new value for the FGCOLOR attribute.protected void setScreenValueInt(character screenValue)
setScreenValueInt
in class GenericWidget<BrowseColumnConfig>
screenValue
- The new value for the SCREEN-VALUE attribute.protected boolean isValidScreenValue(character value)
isValidScreenValue
in class ControlSetEntity<BrowseColumnConfig>
value
- The tested valuepublic character getScreenValue()
getScreenValue
in interface CommonWidget
getScreenValue
in class GenericWidget<BrowseColumnConfig>
character getScreenValue(boolean initialized, BaseDataType bdt, java.lang.String fmt, boolean ignoreFormat)
getScreenValue
in class GenericWidget<BrowseColumnConfig>
initialized
- Flag indicating if the widget is realized or not.bdt
- The current value in the frame's buffer.fmt
- The format to be applied, in case this is a formatted value.ignoreFormat
- Flag indicating if the format needs to be ignored.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 handle getPrevColumn()
getPrevColumn
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
setSort
in class ControlSetEntity<BrowseColumnConfig>
sort
- true
if the combo-box browse columns has sorted items.public void setSort(logical sort)
setSort
in interface SortedElement
setSort
in class ControlSetEntity<BrowseColumnConfig>
sort
- true
if the combo-box browse columns has sorted items.public logical isSort()
isSort
in interface SortedElement
isSort
in class ControlSetEntity<BrowseColumnConfig>
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
setMousePointerName
in class ControlSetEntity<BrowseColumnConfig>
name
- the attribute valuepublic java.lang.String getMousePointerImpl()
getMousePointerImpl
in interface Hoverable
getMousePointerImpl
in class ControlSetEntity<BrowseColumnConfig>
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()
public void setViewAsComboBox()
public void setModeDropDownList()
public void setModeDropDown()
public logical delete(character item)
delete
in interface CommonListWidget<BrowseColumnConfig>
item
- The item or items to delete.true
if the method succeeds.public logical delete(java.lang.String item)
delete
in interface CommonListWidget<BrowseColumnConfig>
item
- The item or items to delete.true
if the method succeeds.public void setVisible(boolean visible)
setVisible
in interface HasVisible
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.public void setAlignment(character alignment)
setAlignment
in interface BrowseColumnInterface
alignment
- Column text alignment, can be "LEFT", "RIGHT" or "CENTER". Pass an unknown value
to reset enhanced alignment and use default 4GL data type-specific alignment.public void setAlignment(java.lang.String alignment)
setAlignment
in interface BrowseColumnInterface
alignment
- Column text alignment, can be "LEFT", "RIGHT" or "CENTER". Pass null
to reset enhanced alignment and use default 4GL data type-specific alignment.public character getAlignment()
getAlignment
in interface BrowseColumnInterface
public logical isEnhancedSorting()
isEnhancedSorting
in interface BrowseElement
true
if enhanced sorting is enabled.public logical isEnhancedFiltering()
isEnhancedFiltering
in interface BrowseElement
true
if enhanced filtering is enabled.public void setEnhancedSorting(boolean sorting)
setEnhancedSorting
in interface BrowseElement
sorting
- true
to enable enhanced sorting. The attribute can be set to true
if
the underlying element is a field reference or the column has DB-SORT-FIELD-MAPPING
set.public void setEnhancedSorting(logical sorting)
setEnhancedSorting
in interface BrowseElement
sorting
- true
to enable enhanced sorting. The attribute can be set to true
if
the underlying element is a field reference or the column has DB-SORT-FIELD-MAPPING
set.public void setEnhancedFiltering(boolean filtering)
setEnhancedFiltering
in interface BrowseElement
filtering
- true
to enable enhanced filtering. The attribute can be set to true
if
the underlying element is a field reference or the column has
DB-FILTER-FIELD-MAPPING
set.public void setEnhancedFiltering(logical filtering)
setEnhancedFiltering
in interface BrowseElement
filtering
- true
to enable enhanced filtering. The attribute can be set to true
if
the underlying element is a field reference or the column has
DB-FILTER-FIELD-MAPPING
set.public void setNoEnhancedSorting(boolean noSorting)
noSorting
- true
to disable enhanced sorting.public void setNoEnhancedFiltering(boolean noFiltering)
noFiltering
- true
to disable enhanced filtering.public BrowseWidget getBrowse()
public void setHonorFormat(boolean b)
setHonorFormat
in interface CommonListWidget<BrowseColumnConfig>
setHonorFormat
in class ControlSetEntity<BrowseColumnConfig>
b
- If true
, the format string will be honored.public character getDbSortFieldMapping()
getDbSortFieldMapping
in interface BrowseColumnInterface
ehDbSortFieldMapping
for more info. unknown
value if it is not specified.public FieldReference getDbSortField()
ehDbSortFieldMapping
for more info.DB-SORT-FIELD-MAPPING
attribute or
null
if DB-SORT-FIELD-MAPPING
is not set or invalid.public FieldReference getDbFilterField()
DB-FILTER-FIELD-MAPPING
attribute: data field,
which this column is filtered by. See ehDbFilterFieldMapping
for more info.DB-FILTER-FIELD-MAPPING
attribute or
null
if DB-FILTER-FIELD-MAPPING
is not set or invalid.public void setDbSortFieldMapping(character fieldMapping)
setDbSortFieldMapping
in interface BrowseColumnInterface
fieldMapping
- Name of data field, which this column is sorted by. See
ehDbSortFieldMapping
for more info.public void setDbSortFieldMapping(java.lang.String fieldMapping)
setDbSortFieldMapping
in interface BrowseColumnInterface
fieldMapping
- The name of the data field, which this column is sorted by. See
ehDbSortFieldMapping
for more info.public character getDbFilterFieldMapping()
getDbFilterFieldMapping
in interface BrowseColumnInterface
ehDbFilterFieldMapping
for more info. unknown
value if it is not specified.public void setDbFilterFieldMapping(character fieldMapping)
setDbFilterFieldMapping
in interface BrowseColumnInterface
fieldMapping
- Name of data field, which this column is filtered by. See
ehDbFilterFieldMapping
for more info.public void setDbFilterFieldMapping(java.lang.String fieldMapping)
setDbFilterFieldMapping
in interface BrowseColumnInterface
fieldMapping
- The name of the data field, which this column is filtered by. See
ehDbFilterFieldMapping
for more info.public boolean hasOverride()
true
if the column is overridden in DEFINE BROWSE statement (e.g. DISPLAY date-var @
char-field).public DisplayFormat getOverrideFormat(BaseDataType value)
null
.value
- A value to be rendered. Defines data type for the override format.protected void setItems(ControlSetItem[] items, java.lang.Boolean pairs, boolean checkItems, java.util.List<ControlSetItem> newAddedItems)
setItems
in class ControlSetEntity<BrowseColumnConfig>
items
- Array of new items.pairs
- true
if LIST_ITEM_PAIRS, RADIO_BUTTONS is set false if LIST_ITEMs is set.checkItems
- If this value is true, then items are checked and truncated.newAddedItems
- The list of new added itemsprotected void setListItemPairsWorker(character list, boolean initScreenValue)
Example: Label1,value1,Label2,value2,...,LabelN,valueN
setListItemPairsWorker
in class ControlSetEntity<BrowseColumnConfig>
list
- A list of delimited items using the configured delimiter for this widget (a comma
by default) to split the items. These items will be set as the full list of items
in this widget.initScreenValue
- In case of TRUE
set up the screen value in addition to the changing
current items set.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.boolean isDropDownList()
true
for
DROP-DOWN-LIST
, false
for DROP-DOWN
.FieldReference getFieldReference()
null
is returned.FieldReference[] getExpressionFieldReferences()
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 boolean isLastVisibleColumn()
true
if the column is a last visible. false
otherwise.private void errorEditorAttributeNotSettable(java.lang.String attributeName)
attributeName
- Attribute name.private boolean checkIfComboBox(java.lang.String attributeName)
attributeName
- Attribute name.true
if the column is a combo-box column. false
otherwise.private void setFgColorInt(NumberType fgColor)
fgColor
- The new value for the FGCOLOR attribute.private void setBgColorInt(NumberType bgColor)
bgColor
- The new value for the BGCOLOR attribute.private void setDColorInt(Color displayColor)
displayColor
- The display color.private FieldReference getFieldReference(java.lang.String fullFieldName, java.lang.String actionName)
fullFieldName
- 4GL name of the target field in format field-name
or
buffer-name.field-name
.actionName
- Action name ("sorting"/"filtering"), used in error messages.private void updateEffectiveEnhancedSorting()
ENHANCED-SORTING
attribute.private void updateEffectiveEnhancedFiltering()
ENHANCED-FILTERING
attribute.