public interface BrowseColumnInterface
Modifier and Type | Method and Description |
---|---|
handle |
bufferField()
Get the handle of the browse column's BUFFER-FIELD.
|
character |
getAlignment()
Returns the actual column text alignment.
|
integer |
getColumnBgColor()
Gets the COLUMN-BGCOLOR writable attribute.
|
integer |
getColumnFgColor()
Gets the COLUMN-FGCOLOR writable attribute.
|
logical |
getColumnReadOnly()
Get the COLUMN-READ-ONLY attribute, which indicates whether you can tab to a browse column
but not edit it.
|
character |
getDbFilterFieldMapping()
Implements the DB-FILTER-FIELD-MAPPING attribute getter.
|
character |
getDbSortFieldMapping()
Implements the DB-SORT-FIELD-MAPPING attribute getter.
|
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.
|
handle |
getNextColumn()
Implements the NEXT-COLUMN attribute getter.
|
handle |
getPrevColumn()
Implements the PREV-COLUMN attribute getter.
|
integer |
getSortNumber()
Get the SORT-NUMBER attribute, which indicates the sort-level number for the browse column.
|
logical |
isSortAscending()
Gets the SORT-ASCENDING attribute, which defines the state of the sort arrow in the column
header.
|
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 |
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 |
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 |
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 |
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 |
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 setColumnBgColor(NumberType param)
param
- The new value for the COLUMN-BGCOLOR attribute.void setColumnBgColor(long param)
param
- The new value for the COLUMN-BGCOLOR attribute.integer getColumnBgColor()
void setColumnFgColor(NumberType param)
param
- The new value for the COLUMN-FGCOLOR attribute.void setColumnFgColor(long param)
param
- The new value for the COLUMN-FGCOLOR attribute.integer getColumnFgColor()
handle getNextColumn()
handle getPrevColumn()
void setSortAscending(logical ascending)
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).void setSortAscending(boolean ascending)
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).logical isSortAscending()
true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).void setSortNumber(int64 sortNumber)
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.void setSortNumber(int sortNumber)
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.integer getSortNumber()
void setColumnReadOnly(logical columnReadOnly)
columnReadOnly
- The new value for the COLUMN-READ-ONLY attribute. true
if you can tab
to a browse column but not edit it.void setColumnReadOnly(boolean columnReadOnly)
columnReadOnly
- The new value for the COLUMN-READ-ONLY attribute. true
if you can tab
to a browse column but not edit it.logical getColumnReadOnly()
handle bufferField()
void setHyperlinkEvent(java.lang.String eventName)
eventName
- The name of the event which is raised when a hyperlink from this column is
clicked. null
do disable hyperlinks for this column.void setHyperlinkEvent(character eventName)
eventName
- The name of the event which is raised when a hyperlink from this column is
clicked. null
do disable hyperlinks for this column.character getHyperlinkEvent()
null
if this is not a hyperlinked column.void setAlignment(character alignment)
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.void setAlignment(java.lang.String alignment)
alignment
- Column text alignment, can be "LEFT", "RIGHT" or "CENTER". Pass null
to reset enhanced alignment and use default 4GL data type-specific alignment.character getAlignment()
character getDbSortFieldMapping()
unknown
value if it is not specified.void setDbSortFieldMapping(character fieldMapping)
fieldMapping
- Name of data field or an expression, which this column is sorted by.void setDbSortFieldMapping(java.lang.String fieldMapping)
fieldMapping
- Name of data field or an expression, which this column is sorted by.character getDbFilterFieldMapping()
unknown
value if it is not specified.void setDbFilterFieldMapping(character fieldMapping)
fieldMapping
- Name of data field or an expression, which this column is filtered by.void setDbFilterFieldMapping(java.lang.String fieldMapping)
fieldMapping
- Name of data field or an expression, which this column is filtered by.