public class BrowseConfig extends BaseConfig
Modifier and Type | Field and Description |
---|---|
boolean |
allowColumnSearching
ALLOW-COLUMN-SEARCHING attribute variable.
|
boolean |
applyEnhancedLayout
true if enhanced layout is applied to for this browse. |
private static int |
ATTR_MASK_ALLOW_COL_SEARCH
Bitwise mask to mark ALLOW CLOUMN SEARCH attribute usage.
|
private static int |
ATTR_MASK_APPLY_ENH_LAYOUT
Bitwise mask to mark APPLY ENHANCED LAYOUT attribute usage.
|
private static int |
ATTR_MASK_AUTO_VALIDATE
Bitwise mask to mark AUTO VALIDATE attribute usage.
|
private static int |
ATTR_MASK_BOX
Bitwise mask to mark BOX attribute usage.
|
private static int |
ATTR_MASK_CENTERED
Bitwise mask to mark CENTERED attribute usage.
|
private static int |
ATTR_MASK_CHANGE_ENH_LAYOUT
Bitwise mask to mark CHANGE ENHANCED LAYOUT attribute usage.
|
private static int |
ATTR_MASK_COL_MOVABLE
Bitwise mask to mark COLUMN MOVABLE attribute usage.
|
private static int |
ATTR_MASK_COL_RESIZABLE
Bitwise mask to mark COLUMN RESIZABLE attribute usage.
|
private static int |
ATTR_MASK_COL_SCROLLING
Bitwise mask to mark COLUMN SCROLLING attribute usage.
|
private static int |
ATTR_MASK_COL_SEPARATORS
Bitwise mask to mark COLUMN SEPARATORS attribute usage.
|
private static int |
ATTR_MASK_COND_REPOSITION
Bitwise mask to mark CONDITIONAL REPOSITION attribute usage.
|
private static int |
ATTR_MASK_CREATE_ON_ADD
Bitwise mask to mark CREATE ON ADD attribute usage.
|
private static int |
ATTR_MASK_DISABLE_CFG_EDIT
Bitwise mask to mark DISABLE-CFG-EDIT attribute usage.
|
private static int |
ATTR_MASK_DISABLE_ROW_STRIPING
Bitwise mask to mark DISABLE-ROW-STRIPING attribute usage.
|
private static int |
ATTR_MASK_DOWN_ASSIGNED
Bitwise mask to mark downAssigned attribute.
|
private static int |
ATTR_MASK_DROP_TARGET
Bitwise mask to mark DROP TARGET attribute usage.
|
private static int |
ATTR_MASK_EDIT_POSSIBLE
Bitwise mask to mark EDIT POSSIBLE attribute usage.
|
private static int |
ATTR_MASK_ENH_FILTERING
Bitwise mask to mark ENHANCED FILTERING attribute usage.
|
private static int |
ATTR_MASK_ENH_SORTING
Bitwise mask to mark ENHANCED SORTING attribute usage.
|
private static int |
ATTR_MASK_EXPORTING
Bitwise mask to mark EXPORTING attribute usage.
|
private static int |
ATTR_MASK_FIT_LAST_COL
Bitwise mask to mark FIT LAST COLUMN attribute usage.
|
private static int |
ATTR_MASK_FIT_LAST_COL_ASSIGNED
Bitwise mask to mark fitLastColumnAssigned attribute.
|
private static int |
ATTR_MASK_HEIGHT_CHANGE_DOWN
Bitwise mask to mark lastHeightChangeIsDown attribute.
|
private static int |
ATTR_MASK_LABELS
Bitwise mask to mark LABELS attribute usage.
|
private static int |
ATTR_MASK_MAX_DATA_REACHED
Bitwise mask to mark MAX SATA REACHED attribute usage.
|
private static int |
ATTR_MASK_MULTIPLE
Bitwise mask to mark MULTIPLE attribute usage.
|
private static int |
ATTR_MASK_NO_ASSIGN
Bitwise mask to mark NO ASSIGN attribute usage.
|
private static int |
ATTR_MASK_NO_EMPTY_SPACE
Bitwise mask to mark NO EMPTY SPACE attribute usage.
|
private static int |
ATTR_MASK_NO_UNDERLINE
Bitwise mask to mark NO UNDERLINE attribute usage.
|
private static int |
ATTR_MASK_NO_VALIDATE
Bitwise mask to mark NO VALIATE attribute usage.
|
private static int |
ATTR_MASK_OVERLAY
Bitwise mask to mark OVERLAY attribute usage.
|
private static int |
ATTR_MASK_QUERY_ASSIGN
Bitwise mask to mark QUERY ASSIGNED attribute usage.
|
private static int |
ATTR_MASK_REFRESHABLE
Bitwise mask to mark REFRESHABLE attribute usage.
|
private static int |
ATTR_MASK_RO
Bitwise mask to mark READ ONLY attribute usage.
|
private static int |
ATTR_MASK_ROW_RESIZABLE
Bitwise mask to mark ROW_RESIZABLE attribute usage.
|
private static int |
ATTR_MASK_ROW_SEPARATORS
Bitwise mask to mark ROW SEPARATORS attribute usage.
|
private static int |
ATTR_MASK_SCROLLABLE
Bitwise mask to mark SCROLLABLE attribute usage.
|
private static int |
ATTR_MASK_SCROLLBAR_VERT
Bitwise mask to mark SCROLLBAR VERTICAL attribute usage.
|
boolean |
autoValidate
AUTO-VALIDATE option.
|
boolean |
box
BOX attribute.
|
boolean |
centered
CENTERED attribute.
|
boolean |
changeEnhancedLayout
true if enhanced layout can be changed for this browse using UI. |
int |
columnBgColor
COLUMN-BGCOLOR option
|
int |
columnFgColor
COLUMN-FGCOLOR option
|
int[] |
columnIds
The IDs of the widgets corresponding with browse's columns.
|
boolean |
columnMovable
COLUMN-MOVABLE attribute.
|
boolean |
columnResizable
COLUMN-RESIZABLE attribute.
|
boolean |
columnScrolling
COLUMN-SCROLLING attribute variable.
|
boolean |
columnSeparators
Enhanced parameter:
true if column separators are drawn. |
boolean |
conditionalReposition
true if reposition mode is "CONDITIONAL", false if reposition mode
is "ALWAYS" (see SET-REPOSITIONED-ROW). |
boolean |
createOnAdd
CREATE-ON-ADD attribute.
|
int |
currentColumnID
The ID of the CURRENT-COLUMN.
|
static int |
DATA_GUESS_DEFAULT_VALUE
Default value for MAX-DATA-GUESS attribute.
|
boolean |
disableEhConfigEdit
Corresponds DISABLE-CFG-EDIT.
|
boolean |
disableEhRowStriping
Corresponds DISABLE-ROW-STRIPING.
|
int |
down
DOWN attribute variable
|
boolean |
downAssigned
This flag is set when
DOWN attribute is explicitly assigned. |
boolean |
dropTarget
DROP-TARGET attribute.
|
boolean |
editPossible
Determine if in-browse editing is possible.
|
ColorRgb |
ehAltBgColor
Enhanced parameter: alternating background color for rows striping.
|
ColorRgb |
ehBgColor
Enhanced parameter: background color.
|
ColorRgb |
ehFgColor
Enhanced parameter: foreground color.
|
FontDetails<?> |
ehFont
Enhanced parameter: browse font.
|
java.lang.String |
ehKeyBrowseName
Part of the enhanced configuration key: the name of the browse.
|
java.lang.String |
ehKeyProcName
Part of the enhanced configuration key: the name of the parent external procedure which
contains the browse.
|
ColorRgb |
ehLabelBgColor
Enhanced parameter: labels background color.
|
ColorRgb |
ehLabelFgColor
Enhanced parameter: labels foreground color.
|
FontDetails<?> |
ehLabelFont
Enhanced parameter: labels font.
|
java.lang.String |
ehReportTitle
Enhanced parameter: report title.
|
ColorRgb |
ehSeparatorsColor
Enhanced parameter: separators color.
|
java.lang.String |
ehStartColumnKeys
String representing the set of the keys of the columns which the browse has at the enhanced
initialization time.
|
java.lang.String |
ehUniqueKey
Part of the enhanced configuration key: an unique string, which, along with procedure name and browse
name, uniquely identifies the browse in an application.
|
boolean |
enhancedFiltering
true if "enhanced filtering" feature is enabled for this browse. |
boolean |
enhancedSorting
true if "enhanced sorting" feature is enabled for this browse. |
boolean |
exporting
true if exporting to PDF/CSV/XLS/XLSX is enabled for this browse. |
boolean |
fitLastColumn
FIT-LAST-COLUMN attribute.
|
boolean |
fitLastColumnAssigned
This flag is set when
FIT-LAST-CODE /EXPANDABLE attribute is explicitly
assigned. |
java.lang.String |
help
HELP attribute variable.
|
int |
labelBgColor
LABEL-BGCOLOR option
|
int |
labelFgColor
LABEL-FGCOLOR option
|
int |
labelFont
LABEL-FONT option
|
boolean |
labels
LABELS attribute variable.
|
int |
labelsHeightNoEnh
Equals
labelsHeightPixels minus height of FWD enhancements located in
the labels area, like column filters. |
int |
labelsHeightPixels
Height of the labels area (in pixels) excluding borders.
|
boolean |
lastHeightChangeIsDown
true if last browse height change was due to DOWN change. |
int |
maxDataGuess
MAX-DATA-GUESS attribute variable.
|
boolean |
maxDataReached
If the end of the result set has been reached.
|
java.lang.Double |
minHeightChars
Minimum height of the browse, in character units.
|
java.lang.String |
mousePointer
MOUSE-POINTER attribute
|
boolean |
multiple
Support multiple selection.
|
boolean |
noAssign
NO-ASSIGN attribute.
|
boolean |
noEmptySpace
NO-EMPTY-SPACE attribute.
|
boolean |
noUnderline
NO-UNDERLINE attribute.
|
boolean |
noValidate
NO-VALIDATE option.
|
int |
numIterations
NUM-ITERATIONS attribute variable.
|
int |
numLockedColumns
NUM-LOCKED-COLUMNS attribute variable.
|
int |
numVisibleColumns
NUM-VISIBLE-COLUMNS attribute variable.
|
boolean |
overlay
OVERLAY attribute.
|
boolean |
performLayout
Client-side only flag indicating that layout needs to be performed or not.
|
boolean |
queryAssigned
true if a query was assigned to the browse. |
boolean |
readOnly
READ-ONLY attribute variable.
|
boolean |
refreshable
REFRESHABLE attribute variable.
|
int |
repositionedRow
0-based repositioned row (see SET-REPOSITIONED-ROW).
|
double |
rowHeightChars
ROW-HEIGHT-CHARS attribute variable.
|
int |
rowHeightPixels
ROW-HEIGHT-PIXELS attribute variable.
|
java.lang.Boolean |
rowMarkers
ROW-MARKERS attribute variable.
|
boolean |
rowResizable
ROW-RESIZABLE attribute.
|
boolean |
rowSeparators
Enhanced parameter:
true if row separators are drawn. |
boolean |
scrollable
SCROLLABLE attribute.
|
boolean |
scrollbarVertical
SCROLLBAR-VERTICAL attribute variable.
|
int |
separatorFgColor
SEPARATOR-FGCOLOR option
|
align, bgcolor, bgcolorRgb, captionFontSize, clientColumn, clientHeightChars, clientHeightPixels, clientRow, clientWidthChars, clientWidthPixels, clientX, clientY, column, dcolor, dynamic, fgcolor, fgcolorRgb, fixedHeight, fixedWidth, font, fontChanged, fontName, fontSize, fontStyle, frameColumnOffset, frameRowOffset, frameXOffset, frameYOffset, heightChars, heightPixels, initColumn, initHeightChars, initRow, initWidthChars, initX, initY, INV_COORD, locationChanged, movable, name, parentId, pfcolor, resizable, row, selected, sysbgcolor, sysfgcolor, systemParentId, tabStop, title, titleDColor, titleFont, tooltip, widgetPlaced, widthChars, widthPixels, x, y
cfgClass, contextHelpId, disableRedraw, enabled, frameDefValue, frameId, header, hidden, id, manualHightlight, menuKey, menuMouse, modified, popupMenuId, realized, selectable, state, visible, wasRealized, zorder
Modifier | Constructor and Description |
---|---|
|
BrowseConfig()
Default constructor (only used in de-serialization).
|
protected |
BrowseConfig(int id)
Create a new config and associate it with the given widget.
|
protected |
BrowseConfig(WidgetId id)
Create a new config and associate it with the given widget.
|
Modifier and Type | Method and Description |
---|---|
void |
applyConfig(WidgetConfig config)
Set new values from the provided configuration instance.
|
boolean |
isSeparators()
Returns value of the legacy SEPARATORS attribute.
|
void |
readExternal(java.io.ObjectInput in)
Replacement for the default object reading method.
|
void |
writeExternal(java.io.ObjectOutput out)
Replacement for the default object writing method.
|
getConfigManager, getDynamicColumnLabel, getDynamicFormat, getDynamicHelp, getDynamicLabel, getDynamicUntranslatedLabel, markFieldsDirty, setDynamicFormat, setDynamicHeader, setDynamicHelp, setDynamicLabel, setDynamicLabels, setDynamicUntranslatedLabel, toString
public static final int DATA_GUESS_DEFAULT_VALUE
public int numIterations
public boolean rowSeparators
true
if row separators are drawn.public boolean columnSeparators
true
if column separators are drawn.public boolean allowColumnSearching
public boolean columnScrolling
ISSUE: non-default behavior is not implemented.
public int down
public boolean labels
public int maxDataGuess
public boolean maxDataReached
public int numLockedColumns
public int numVisibleColumns
public boolean readOnly
public boolean refreshable
public double rowHeightChars
public int rowHeightPixels
public java.lang.Boolean rowMarkers
null
for default value (depends on GUI/ChUI,
static/dynamic, editable/read-only).public boolean scrollbarVertical
public java.lang.String help
public boolean multiple
public boolean queryAssigned
true
if a query was assigned to the browse.public boolean box
public boolean overlay
public boolean centered
public boolean noAssign
public boolean fitLastColumn
public boolean noEmptySpace
public boolean noUnderline
public boolean scrollable
public boolean columnResizable
public boolean columnMovable
public boolean createOnAdd
public boolean editPossible
public int repositionedRow
public boolean noValidate
public boolean autoValidate
public boolean conditionalReposition
true
if reposition mode is "CONDITIONAL", false
if reposition mode
is "ALWAYS" (see SET-REPOSITIONED-ROW).public int[] columnIds
public transient boolean performLayout
public int separatorFgColor
public int columnFgColor
public int columnBgColor
public int labelFgColor
public int labelBgColor
public int labelFont
public java.lang.String mousePointer
public java.lang.Double minHeightChars
public boolean dropTarget
public boolean rowResizable
public boolean applyEnhancedLayout
true
if enhanced layout is applied to for this browse.public boolean changeEnhancedLayout
true
if enhanced layout can be changed for this browse using UI.public boolean exporting
true
if exporting to PDF/CSV/XLS/XLSX is enabled for this browse.public boolean enhancedSorting
true
if "enhanced sorting" feature is enabled for this browse.public boolean enhancedFiltering
true
if "enhanced filtering" feature is enabled for this browse.public ColorRgb ehFgColor
public ColorRgb ehBgColor
public ColorRgb ehAltBgColor
public ColorRgb ehLabelFgColor
public ColorRgb ehLabelBgColor
public ColorRgb ehSeparatorsColor
public FontDetails<?> ehFont
public FontDetails<?> ehLabelFont
public java.lang.String ehReportTitle
public java.lang.String ehKeyProcName
public java.lang.String ehKeyBrowseName
public java.lang.String ehUniqueKey
public java.lang.String ehStartColumnKeys
buffer_alias.field_name
. For calculated and computed columns it is an expression containing
column parameters like column data type, format, initial value and label. Keys are separated with ";"
and lexicographically sorted within the string (for easy comparison). The string cannot contain empty
keys.public int labelsHeightPixels
public int labelsHeightNoEnh
labelsHeightPixels
minus height of FWD enhancements located in
the labels area, like column filters.public boolean disableEhRowStriping
public boolean downAssigned
DOWN
attribute is explicitly assigned. Used because in 4GL you can
use browse:DOWN = browse:DOWN
to fit browse height exactly to the number of rows.public boolean lastHeightChangeIsDown
true
if last browse height change was due to DOWN change. false
otherwisepublic boolean disableEhConfigEdit
public boolean fitLastColumnAssigned
FIT-LAST-CODE
/EXPANDABLE
attribute is explicitly
assigned. Used because in 4GL you can set a column width and then set this attribute (even if it is
already set) to force column fitting.public int currentColumnID
private static final int ATTR_MASK_QUERY_ASSIGN
private static final int ATTR_MASK_ROW_SEPARATORS
private static final int ATTR_MASK_COL_SEPARATORS
private static final int ATTR_MASK_ALLOW_COL_SEARCH
private static final int ATTR_MASK_COL_SCROLLING
private static final int ATTR_MASK_LABELS
private static final int ATTR_MASK_RO
private static final int ATTR_MASK_REFRESHABLE
private static final int ATTR_MASK_SCROLLBAR_VERT
private static final int ATTR_MASK_MULTIPLE
private static final int ATTR_MASK_BOX
private static final int ATTR_MASK_OVERLAY
private static final int ATTR_MASK_CENTERED
private static final int ATTR_MASK_MAX_DATA_REACHED
private static final int ATTR_MASK_NO_ASSIGN
private static final int ATTR_MASK_FIT_LAST_COL
private static final int ATTR_MASK_NO_EMPTY_SPACE
private static final int ATTR_MASK_NO_UNDERLINE
private static final int ATTR_MASK_SCROLLABLE
private static final int ATTR_MASK_COL_RESIZABLE
private static final int ATTR_MASK_COL_MOVABLE
private static final int ATTR_MASK_CREATE_ON_ADD
private static final int ATTR_MASK_EDIT_POSSIBLE
private static final int ATTR_MASK_COND_REPOSITION
private static final int ATTR_MASK_NO_VALIDATE
private static final int ATTR_MASK_AUTO_VALIDATE
private static final int ATTR_MASK_DROP_TARGET
private static final int ATTR_MASK_ROW_RESIZABLE
private static final int ATTR_MASK_APPLY_ENH_LAYOUT
private static final int ATTR_MASK_CHANGE_ENH_LAYOUT
private static final int ATTR_MASK_EXPORTING
private static final int ATTR_MASK_ENH_SORTING
private static final int ATTR_MASK_ENH_FILTERING
private static final int ATTR_MASK_DISABLE_ROW_STRIPING
private static final int ATTR_MASK_DISABLE_CFG_EDIT
private static final int ATTR_MASK_DOWN_ASSIGNED
private static final int ATTR_MASK_HEIGHT_CHANGE_DOWN
private static final int ATTR_MASK_FIT_LAST_COL_ASSIGNED
public BrowseConfig()
protected BrowseConfig(int id)
id
- The ID of the widget to which this configuration belongs.protected BrowseConfig(WidgetId id)
id
- The ID of the widget to which this configuration belongs.public boolean isSeparators()
public void applyConfig(WidgetConfig config)
applyConfig
in class BaseConfig
config
- The instance from which to take values.public void readExternal(java.io.ObjectInput in) throws java.io.IOException, java.lang.ClassNotFoundException
readExternal
in interface java.io.Externalizable
readExternal
in class BaseConfig
in
- The input source from which fields will be restored.java.io.IOException
- In case of I/O errors.java.lang.ClassNotFoundException
- If payload can't be instantiated.public void writeExternal(java.io.ObjectOutput out) throws java.io.IOException
writeExternal
in interface java.io.Externalizable
writeExternal
in class BaseConfig
out
- The output destination to which fields will be saved.java.io.IOException
- In case of I/O errors.