public interface BrowseInterface extends NumEntries
Modifier and Type | Method and Description |
---|---|
handle |
addCalcColumn(character dataType,
character format,
character initialValue,
character label)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(character dataType,
character format,
character initialValue,
character label,
NumberType position)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(character dataType,
character format,
character initialValue,
character label,
NumberType position,
character widgetType)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(character dataType,
character format,
java.lang.String initialValue,
character label)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
BaseDataType initialValue,
java.lang.String label)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
BaseDataType initialValue,
java.lang.String label,
int position)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
int initialValue,
java.lang.String label,
int position)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
java.lang.String initialValue,
character label)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
java.lang.String initialValue,
java.lang.String label)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
java.lang.String initialValue,
java.lang.String label,
int position)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addCalcColumn(java.lang.String dataType,
java.lang.String format,
java.lang.String initialValue,
java.lang.String label,
int position,
java.lang.String widgetType)
Creates a browse column from the specified properties and returns the handle of the new
column.
|
handle |
addLikeColumn(character fieldName)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(character fieldName,
int64 position)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(handle fieldHandle)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(handle fieldHandle,
int64 position)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(handle fieldHandle,
long position)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(java.lang.String fieldName)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(java.lang.String fieldName,
int64 position)
Implements the ADD-LIKE-COLUMN() widget method.
|
handle |
addLikeColumn(java.lang.String fieldName,
long position)
Implements the ADD-LIKE-COLUMN() widget method.
|
logical |
clearSortArrows()
Resets sort-arrow indicators and sort-level numbers for all browse columns.
|
logical |
deleteCurrentRow()
Implements the DELETE-CURRENT-ROW() widget method.
|
logical |
deleteSelectedRow(int row)
Implements the DELETE-SELECTED-ROW() widget method.
|
logical |
deleteSelectedRow(int64 row)
Implements the DELETE-SELECTED-ROW() widget method.
|
logical |
deleteSelectedRows()
Implements the DELETE-SELECTED-ROWS() widget method.
|
logical |
deselectFocusedRow()
Implements the DESELECT-FOCUSED-ROW() widget method.
|
logical |
deselectSelectedRow(int row)
Implements the DESELECT-SELECTED-ROW() widget method.
|
logical |
deselectSelectedRow(int64 row)
Implements the DESELECT-SELECTED-ROW() widget method.
|
logical |
fetchSelectedRow(int64 n)
Implements the FETCH-SELECTED-ROW() widget method.
|
logical |
fetchSelectedRow(long n)
Implements the FETCH-SELECTED-ROW() widget method.
|
handle |
getBrowseColumn(int index)
Get specified browse column.
|
handle |
getBrowseColumn(NumberType index)
Get specified browse column.
|
integer |
getColumnBgColor()
Get the COLUMN-BGCOLOR attribute value.
|
integer |
getColumnFgColor()
Get the COLUMN-FGCOLOR attribute value.
|
handle |
getCurrentColumn()
Get the current column (a column can be selected by clicking on its header if
ALLOW-COLUMN-SEARCHING is
true ). |
handle |
getFirstColumn()
Implements the FIRST-COLUMN attribute getter.
|
integer |
getFocusedRow()
Implements the FOCUSED-ROW attribute getter.
|
integer |
getLabelBgColor()
Gets the LABEL-BGCOLOR writable attribute.
|
integer |
getMaxDataGuess()
Get value of the MAX-DATA-GUESS attribute.
|
decimal |
getMinHeightChars()
Implements the MIN-HEIGHT-CHARS attribute getter.
|
integer |
getNumLockedColumns()
Implements the NUM-LOCKED-COLUMNS attribute getter.
|
handle |
getReport()
Get the
FwdReport object associated with this browse. |
integer |
getRepositionedRow()
Implements the GET-REPOSITIONED-ROW() widget method.
|
decimal |
getRowHeightChars()
Implements the ROW-HEIGHT-CHARS attribute getter.
|
integer |
getSeparatorFgColor()
Get the SEPARATOR-FGCOLOR attribute value.
|
logical |
hasRowMarkers()
Get value of the ROW-MARKERS attribute.
|
logical |
insertRow()
Implements the INSERT-ROW() widget method.
|
logical |
insertRow(character mode)
Implements the INSERT-ROW() widget method.
|
logical |
insertRow(java.lang.String mode)
Implements the INSERT-ROW() widget method.
|
logical |
isAllowColumnSearching()
Implements the ALLOW-COLUMN-SEARCHING attribute getter.
|
logical |
isAutoValidate()
Gets the AUTO-VALIDATE attribute.
|
logical |
isColumnMovable()
Get value of the COLUMN-MOVABLE attribute.
|
logical |
isColumnResizable()
Get value of the COLUMN-RESIZABLE attribute.
|
logical |
isColumnScrolling()
Get value of the COLUMN-SCROLLING attribute.
|
logical |
isCreateOnAdd()
Get value of the CREATE-ON-ADD attribute.
|
logical |
isCurrentRowModified()
Get value of the CURRENT-ROW-MODIFIED attribute.
|
logical |
isExpandable()
Get value of the EXPANDABLE attribute.
|
logical |
isFitLastColumn()
Get value of the FIT-LAST-COLUMN attribute.
|
logical |
isNewRow()
Get value of the NEW-ROW attribute.
|
logical |
isNoValidate()
Gets the NO-VALIDATE attribute.
|
logical |
isRefreshable()
Get value of the REFRESHABLE attribute.
|
logical |
isRowResizable()
Get value of the ROW-RESIZABLE attribute.
|
logical |
isRowSelected(int row)
Implements the IS-ROW-SELECTED() widget method.
|
logical |
isRowSelected(int64 row)
Implements the IS-ROW-SELECTED() widget method.
|
logical |
isScrollable()
Gets the SCROLLABLE writeable attribute.
|
logical |
isSeparators()
Implements the SEPARATORS attribute getter.
|
logical |
moveColumn(int64 src,
int64 dest)
Implements the MOVE-COLUMN() widget method.
|
logical |
moveColumn(int64 src,
long dest)
Implements the MOVE-COLUMN() widget method.
|
logical |
moveColumn(long src,
int64 dest)
Implements the MOVE-COLUMN() widget method.
|
logical |
moveColumn(long src,
long dest)
Implements the MOVE-COLUMN() widget method.
|
logical |
scrollToCurrentRow()
Scrolls a browse (if necessary) to bring the currently selected row into view.
|
logical |
scrollToSelectedRow(int selectedRowIndex)
Scrolls a browse (if necessary) to bring the specified selected row into view.
|
logical |
scrollToSelectedRow(NumberType selectedRowIndex)
Scrolls a browse (if necessary) to bring the specified selected row into view.
|
logical |
selectFocusedRow()
Implements the SELECT-FOCUSED-ROW() widget method.
|
logical |
selectNextRow()
Implements the SELECT-NEXT-ROW() widget method.
|
logical |
selectPreviousRow()
Implements the SELECT-PREV-ROW() widget method.
|
logical |
selectRow(int64 row)
Implements the SELECT-ROW() widget method.
|
logical |
selectRow(long row)
Implements the SELECT-ROW() widget method.
|
void |
setAllowColumnSearching(boolean allow)
Implements the ALLOW-COLUMN-SEARCHING attribute setter.
|
void |
setAllowColumnSearching(logical allow)
Implements the ALLOW-COLUMN-SEARCHING attribute setter.
|
void |
setAutoValidate(boolean value)
Sets the AUTO-VALIDATE writable attribute.
|
void |
setAutoValidate(logical value)
Sets the AUTO-VALIDATE writable attribute.
|
void |
setColumnBgColor(int64 color)
Sets the COLUMN-BGCOLOR writable attribute.
|
void |
setColumnBgColor(long color)
Sets the COLUMN-BGCOLOR writable attribute.
|
void |
setColumnFgColor(int64 color)
Sets the COLUMN-FGCOLOR writable attribute.
|
void |
setColumnFgColor(long color)
Sets the COLUMN-FGCOLOR writable attribute.
|
void |
setColumnMovable(boolean movable)
Set value of the COLUMN-MOVABLE attribute.
|
void |
setColumnMovable(logical movable)
Set value of the COLUMN-MOVABLE attribute.
|
void |
setColumnResizable(boolean resizable)
Set value of the COLUMN-RESIZABLE attribute.
|
void |
setColumnResizable(logical resizable)
Set value of the COLUMN-RESIZABLE attribute.
|
void |
setColumnScrolling(boolean columnScrolling)
Set value of the COLUMN-SCROLLING attribute.
|
void |
setColumnScrolling(logical columnScrolling)
Set value of the COLUMN-SCROLLING attribute.
|
void |
setCreateOnAdd(boolean createOnAdd)
Set value of the CREATE-ON-ADD attribute.
|
void |
setCreateOnAdd(logical createOnAdd)
Set value of the CREATE-ON-ADD attribute.
|
void |
setCurrentColumn(handle columnHandle)
Set the current column (a column can be selected by clicking on its header if
ALLOW-COLUMN-SEARCHING is
true ). |
void |
setExpandable(boolean expandable)
Set value of the EXPANDABLE attribute.
|
void |
setExpandable(logical expandable)
Set value of the EXPANDABLE attribute.
|
void |
setFitLastColumn(boolean fitLastColumn)
Set value of the FIT-LAST-COLUMN attribute.
|
void |
setFitLastColumn(logical fitLastColumn)
Set value of the FIT-LAST-COLUMN attribute.
|
void |
setLabelBgColor(int64 bgcolor)
Sets the LABEL-BGCOLOR writable attribute.
|
void |
setLabelBgColor(long bgcolor)
Sets the LABEL-BGCOLOR writable attribute.
|
void |
setMaxDataGuess(double maxDataGuess)
Set value of the MAX-DATA-GUESS attribute.
|
void |
setMaxDataGuess(NumberType maxDataGuess)
Set value of the MAX-DATA-GUESS attribute.
|
void |
setNoValidate(boolean value)
Sets the NO-VALIDATE writable attribute.
|
void |
setNoValidate(logical value)
Sets the NO-VALIDATE writable attribute.
|
void |
setNumLockedColumns(double num)
Implements the NUM-LOCKED-COLUMNS attribute setter.
|
void |
setNumLockedColumns(NumberType num)
Implements the NUM-LOCKED-COLUMNS attribute setter.
|
void |
setRefreshable(boolean refreshable)
Set value of the REFRESHABLE attribute.
|
void |
setRefreshable(logical refreshable)
Set value of the REFRESHABLE attribute.
|
logical |
setRepositionedRow(int64 row)
Provides the SET-REPOSITIONED-ROW() method which assigns the row number and type of
repositioning for the browse.
|
logical |
setRepositionedRow(int64 row,
java.lang.String cond)
Provides the SET-REPOSITIONED-ROW() method which assigns the row number and type of
repositioning for the browse.
|
logical |
setRepositionedRow(long row)
Provides the SET-REPOSITIONED-ROW() method which assigns the row number and type of
repositioning for the browse.
|
logical |
setRepositionedRow(long row,
java.lang.String cond)
Provides the SET-REPOSITIONED-ROW() method which assigns the row number and type of
repositioning for the browse.
|
void |
setRowHeightChars(double rowHeightChars)
Set value of the ROW-HEIGHT-CHARS attribute.
|
void |
setRowHeightChars(NumberType rowHeightChars)
Set value of the ROW-HEIGHT-CHARS attribute.
|
void |
setRowMarkers(boolean markers)
Set value of the ROW-MARKERS attribute.
|
void |
setRowMarkers(logical markers)
Set value of the ROW-MARKERS attribute.
|
void |
setRowResizable(boolean flag)
Set value of the ROW-RESIZABLE attribute.
|
default void |
setRowResizable(logical flag)
Set value of the REFRESHABLE attribute.
|
void |
setScrollable(boolean scroll)
Sets the SCROLLABLE writeable attribute.
|
void |
setScrollable(logical scroll)
Sets the SCROLLABLE writeable attribute.
|
void |
setSeparatorFgColor(int64 color)
Sets the SEPARATOR-FGCOLOR writable attribute.
|
void |
setSeparatorFgColor(long color)
Sets the SEPARATOR-FGCOLOR writable attribute.
|
void |
setSeparators(boolean separators)
Set SEPARATORS attribute.
|
void |
setSeparators(logical separators)
Set SEPARATORS attribute.
|
logical |
setSortArrow(int64 columnIndex,
logical ascending)
Sets the sort-arrow indicator and resets sort-level number for a browse column.
|
logical |
setSortArrow(int64 columnIndex,
logical ascending,
int64 sortNumber)
Sets the sort-arrow indicator and the sort-level number for a browse column.
|
logical |
setSortArrow(int columnIndex,
boolean ascending)
Sets the sort-arrow indicator and resets sort-level number for a browse column.
|
logical |
setSortArrow(int columnIndex,
boolean ascending,
int sortNumber)
Sets the sort-arrow indicator and the sort-level number for a browse column.
|
integer |
visibleIterations()
Get the number of rows currently visible in a browse widget.
|
getNumEntries, setNumEntries, setNumEntries
logical fetchSelectedRow(int64 n)
n
- 1-based index of the selected row to fetch; note that this is
the index into the list of selected rows within the browse,
NOT the index of the row itself.true
if method succeeds.logical fetchSelectedRow(long n)
n
- 1-based index of the selected row to fetch; note that this is
the index into the list of selected rows within the browse,
NOT the index of the row itself.true
if method succeeds.logical isFitLastColumn()
void setFitLastColumn(boolean fitLastColumn)
fitLastColumn
- New value of the attribute.void setFitLastColumn(logical fitLastColumn)
fitLastColumn
- New value of the attribute.void setColumnScrolling(boolean columnScrolling)
columnScrolling
- New value of the attribute.void setColumnScrolling(logical columnScrolling)
columnScrolling
- New value of the attribute.logical isColumnScrolling()
true
if browse is scrolled horizontally per column.
false
for usual scrolling.void setExpandable(boolean expandable)
expandable
- New value of the attribute.void setExpandable(logical expandable)
expandable
- New value of the attribute.logical isExpandable()
void setColumnResizable(boolean resizable)
resizable
- true
you can resize a browse column by pointing, clicking, and
dragging.void setColumnResizable(logical resizable)
resizable
- true
you can resize a browse column by pointing, clicking, and
dragging.logical isColumnResizable()
true
you can resize a browse column by pointing, clicking, and
dragging.void setColumnMovable(boolean movable)
movable
- true
you can move a browse column by pointing, clicking, and
dragging.void setColumnMovable(logical movable)
movable
- true
you can move a browse column by pointing, clicking, and
dragging.logical isColumnMovable()
true
you can move a browse column by pointing, clicking, and
dragging.logical isCreateOnAdd()
void setCreateOnAdd(boolean createOnAdd)
createOnAdd
- New value of the attribute.void setCreateOnAdd(logical createOnAdd)
createOnAdd
- New value of the attribute.void setRefreshable(boolean refreshable)
refreshable
- true
if the rows that appear in a browse are refreshed when an
application opens or repositions a query.void setRefreshable(logical refreshable)
refreshable
- true
if the rows that appear in a browse are refreshed when an
application opens or repositions a query.logical isRefreshable()
true
if the rows that appear in a browse are refreshed when an
application opens or repositions a query.void setRowResizable(boolean flag)
flag
- true
if the row height can be changed.default void setRowResizable(logical flag)
flag
- true
if the row height can be changed.logical isRowResizable()
true
if the row height can be changed.logical isCurrentRowModified()
true
if any cells in the current row have been changed.logical isNewRow()
true
if the row in focus was added to the browse using the
INSERT-ROW() method and has not been added to the database.logical hasRowMarkers()
true
if the browse has row markers.void setRowMarkers(boolean markers)
markers
- New value of the attribute.void setRowMarkers(logical markers)
markers
- New value of the attribute.integer getLabelBgColor()
void setLabelBgColor(int64 bgcolor)
bgcolor
- The new value for the LABEL-BGCOLOR attribute.void setLabelBgColor(long bgcolor)
bgcolor
- The new value for the LABEL-BGCOLOR attribute.void setRowHeightChars(double rowHeightChars)
rowHeightChars
- New value of the attribute.void setRowHeightChars(NumberType rowHeightChars)
rowHeightChars
- New value of the attribute.decimal getRowHeightChars()
logical selectFocusedRow()
Selects the row that currently has focus in a browse widget, even if it is not currently displayed.
true
.logical deselectFocusedRow()
Deselects the row with current focus.
true
if the browse has at least one record.logical selectRow(int64 row)
Selects the specified row if it is currently in the browse viewport. In a single-select browse, the previously selected row is deselected. No rows are deselected in a multiple-select browse.
row
- 1-based row index in the browse viewport.true
if the row with the given index exist in the browse viewport.logical selectRow(long row)
Selects the specified row if it is currently in the browse viewport. In a single-select browse, the previously selected row is deselected. No rows are deselected in a multiple-select browse.
row
- 1-based row index in the browse viewport.true
if the row with the given index exist in the browse viewport.logical selectNextRow()
Deselects all currently selected rows in a browse and selects the row after the deselected row.
This method also repositions the query to the new row and copies the record into the database buffer. The browse automatically scrolls to the selected row if it is out of view.
This method is intended for use with a browse that supports the selection of a single row at a time (MULTIPLE attribute is set to FALSE). If more than one row is selected when you execute this method, all of the selected rows are deselected and the record after the last selected row becomes the selected row.
logical selectPreviousRow()
Deselects all currently selected rows in a browse and selects the row before the deselected row.
This method also repositions the query to the new row and copies the record into the database buffer.The browse automatically scrolls to the selected row if it is out of view.
This method is intended for use with a browse that supports the selection of a single row at a time (MULTIPLE attribute is set to FALSE). If more than one row is selected when you execute this method, all of the selected rows are deselected and the record before the last selected row becomes the selected row.
logical deselectSelectedRow(int64 row)
Deselects the nth selected row in a browse.
Progress maintains a numbered list of selected rows, starting at 1. When the DESELECT-SELECTED-ROW(n) method is encountered, Progress searches this list to find the nth selected row.
row
- 1-based index of a selected row (rows are numbered in the order they were
selected).true
if the row is successfully deselected.logical deselectSelectedRow(int row)
Deselects the nth selected row in a browse.
Progress maintains a numbered list of selected rows, starting at 1. When the DESELECT-SELECTED-ROW(n) method is encountered, Progress searches this list to find the nth selected row.
row
- 1-based index of a selected row (rows are numbered in the order they were
selected).true
if the row is successfully deselected.logical deleteSelectedRow(int64 row)
Deletes the nth selected row from a browse and the results list.
Progress maintains a numbered list of selected rows, starting at 1. When the DELETE-SELECTED-ROW(n) method is encountered, Progress searches this list to find the nth selected row.
This method does not delete the record from the database and has no effect on the database buffer.
row
- 1-based index of a row to delete (rows are numbered in the order they were
selected).true
if the row is successfully deleted.logical deleteSelectedRow(int row)
Deletes the nth selected row from a browse and the results list.
Progress maintains a numbered list of selected rows, starting at 1. When the DELETE-SELECTED-ROW(n) method is encountered, Progress searches this list to find the nth selected row.
This method does not delete the record from the database and has no effect on the database buffer.
row
- 1-based index of a row to delete (rows are numbered in the order they were
selected).true
if the row is successfully deleted.logical deleteSelectedRows()
Deletes all currently selected rows from a browse and the associated results list.
This method does not delete the record from the database and has no effect on the database buffer.
true
if rows were successfully deleted.logical deleteCurrentRow()
Deletes the most recently selected row from a browse and the results list.
This method does not delete the record from the database and has no effect on the database buffer.
true
if the row is successfully deleted.logical isRowSelected(int64 row)
Returns true
if a specified row in the browse viewport is currently selected.
row
- 1-based row index in the browse viewport.true
if a specified row in the browse viewport is currently selected.logical isRowSelected(int row)
Returns true
if a specified row in the browse viewport is currently selected.
row
- 1-based row index in the browse viewport.true
if a specified row in the browse viewport is currently selected.logical insertRow(character mode)
Inserts a blank line in an updateable browse before or after the last selected row. The blank line is a placeholder for a new record to be added through the browse. This method cannot be used with a read-only browse.
mode
- "BEFORE"
if a row should be added before the current browse row.
"AFTER"
if a row should be added after the current browse row.true
if a row was successfully added.logical insertRow(java.lang.String mode)
Inserts a blank line in an updateable browse before or after the last selected row. The blank line is a placeholder for a new record to be added through the browse. This method cannot be used with a read-only browse.
mode
- "BEFORE"
if a row should be added before the current browse row.
"AFTER"
if a row should be added after the current browse row.true
if a row was successfully added.logical insertRow()
Inserts a blank line in an updateable browse before the last selected row. The blank line is a placeholder for a new record to be added through the browse. This method cannot be used with a read-only browse.
true
if a row was successfully added.handle addLikeColumn(java.lang.String fieldName, int64 position)
Creates a browse column from the specified field and returns its widget handle.
fieldName
- The name of a field in one of the buffers associated with the browse's query. If the
query is a join, the name must be qualified with the database name.position
- 1-based position of the browse column.handle addLikeColumn(character fieldName, int64 position)
Creates a browse column from the specified field and returns its widget handle.
fieldName
- The name of a field in one of the buffers associated with the browse's query. If the
query is a join, the name must be qualified with the database name.position
- 1-based position of the browse column.handle addLikeColumn(java.lang.String fieldName, long position)
Creates a browse column from the specified field and returns its widget handle.
fieldName
- The name of a field in one of the buffers associated with the browse's query. If the
query is a join, the name must be qualified with the database name.position
- 1-based position of the browse column.handle addLikeColumn(handle fieldHandle, int64 position)
Creates a browse column from the specified field and returns its widget handle.
fieldHandle
- Handle to a field in one of the buffers associated with the browse's query.position
- 1-based position of the browse column.handle addLikeColumn(handle fieldHandle, long position)
Creates a browse column from the specified field and returns its widget handle.
fieldHandle
- Handle to a field in one of the buffers associated with the browse's query.position
- 1-based position of the browse column.handle addLikeColumn(character fieldName)
Creates a browse column from the specified field, adds it to the end of the columns and returns its widget handle.
fieldName
- The name of a field in one of the buffers associated with the browse's query. If the
query is a join, the name must be qualified with the database name.handle addLikeColumn(java.lang.String fieldName)
Creates a browse column from the specified field, adds it to the end of the columns and returns its widget handle.
fieldName
- The name of a field in one of the buffers associated with the browse's query. If the
query is a join, the name must be qualified with the database name.handle addLikeColumn(handle fieldHandle)
Creates a browse column from the specified field, adds it to the end of the columns and returns its widget handle.
fieldHandle
- Handle to a field in one of the buffers associated with the browse's query.handle addCalcColumn(java.lang.String dataType, java.lang.String format, java.lang.String initialValue, java.lang.String label)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.handle addCalcColumn(java.lang.String dataType, java.lang.String format, java.lang.String initialValue, character label)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.handle addCalcColumn(character dataType, character format, java.lang.String initialValue, character label)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.handle addCalcColumn(java.lang.String dataType, java.lang.String format, java.lang.String initialValue, java.lang.String label, int position)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.position
- The optional integer value position of the browse column. If pos = 2, the column is
the second column. If the position is not specified or the position is invalid, the
new column is added at the end of the columns.handle addCalcColumn(java.lang.String dataType, java.lang.String format, java.lang.String initialValue, java.lang.String label, int position, java.lang.String widgetType)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.position
- The optional integer value position of the browse column. If pos = 2, the column is
the second column. If the position is not specified or the position is invalid, the
new column is added at the end of the columns.widgetType
- An optional character expression specifying the widget type of the column. Valid
values are "COMBO-BOX", "DROP-DOWN", "DROP-DOWN-LIST", "FILL-IN" and "TOGGLE-BOX".
The default value is "FILL-IN". If datatype-exp is not "LOGICAL", specifying
"TOGGLE-BOX" as the widget type generates a run-time error. The widget-type
parameter is ignored in character mode.handle addCalcColumn(character dataType, character format, character initialValue, character label)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.handle addCalcColumn(character dataType, character format, character initialValue, character label, NumberType position)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.position
- The optional integer value position of the browse column. If pos = 2, the column is
the second column. If the position is not specified or the position is invalid, the
new column is added at the end of the columns.handle addCalcColumn(java.lang.String dataType, java.lang.String format, BaseDataType initialValue, java.lang.String label)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.handle addCalcColumn(java.lang.String dataType, java.lang.String format, int initialValue, java.lang.String label, int position)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.position
- The optional integer value position of the browse column. If pos = 2, the column is
the second column. If the position is not specified or the position is invalid, the
new column is added at the end of the columns.handle addCalcColumn(java.lang.String dataType, java.lang.String format, BaseDataType initialValue, java.lang.String label, int position)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.position
- The optional integer value position of the browse column. If pos = 2, the column is
the second column. If the position is not specified or the position is invalid, the
new column is added at the end of the columns.handle addCalcColumn(character dataType, character format, character initialValue, character label, NumberType position, character widgetType)
dataType
- Character expression specifying the data type. Valid values are "CHARACTER", "DATE",
"DECIMAL", "INTEGER", "INT64", or "LOGICAL".format
- Character expression specifying the column's format.initialValue
- Character expression specifying the initial value. This may be a null string.label
- Character expression specifying the column's label.position
- 1-based position of the browse column (i.e. if pos = 2, the column is the second
column). If the position is null
or invalid, the new column is added at
the end of the columns.widgetType
- An optional character expression specifying the widget type of the column. Valid
values are "COMBO-BOX", "DROP-DOWN", "DROP-DOWN-LIST", "FILL-IN" and "TOGGLE-BOX".
The default value is "FILL-IN". If datatype-exp is not "LOGICAL", specifying
"TOGGLE-BOX" as the widget type generates a run-time error. The widget-type
parameter is ignored in character mode.logical moveColumn(int64 src, int64 dest)
Repositions a column in a browse widget.
src
- 1-based position of the column to be moved.dest
- 1-based position to which the column is moved.true
if the column was successfully moved.logical moveColumn(long src, int64 dest)
Repositions a column in a browse widget.
src
- 1-based position of the column to be moved.dest
- 1-based position to which the column is moved.true
if the column was successfully moved.logical moveColumn(int64 src, long dest)
Repositions a column in a browse widget.
src
- 1-based position of the column to be moved.dest
- 1-based position to which the column is moved.true
if the column was successfully moved.logical moveColumn(long src, long dest)
Repositions a column in a browse widget.
src
- 1-based position of the column to be moved.dest
- 1-based position to which the column is moved.true
if the column was successfully moved.integer getRepositionedRow()
Returns the row index of the browse viewport where the REPOSITION TO ROWID (or RECID) statement displays a repositioned record.
handle getFirstColumn()
integer getFocusedRow()
integer getNumLockedColumns()
void setNumLockedColumns(double num)
num
- The number of visible leading columns locked in a browse widget.void setNumLockedColumns(NumberType num)
num
- The number of visible leading columns locked in a browse widget.decimal getMinHeightChars()
logical isAllowColumnSearching()
true
if column searching is allowed for the browse.void setAllowColumnSearching(boolean allow)
allow
- true
if column searching is allowed for the browse.void setAllowColumnSearching(logical allow)
allow
- true
if column searching is allowed for the browse.void setMaxDataGuess(double maxDataGuess)
maxDataGuess
- The estimated number of records in a browse query.void setMaxDataGuess(NumberType maxDataGuess)
maxDataGuess
- The estimated number of records in a browse query.integer getMaxDataGuess()
logical setRepositionedRow(int64 row)
row
- 1-based row number where the new record is displayedtrue
if
operation was successful.logical setRepositionedRow(long row)
row
- 1-based row number where the new record is displayedtrue
if
operation was successful.logical setRepositionedRow(int64 row, java.lang.String cond)
row
- 1-based row number where the new record is displayedcond
- If this parameter is "conditional", then method tries to
reposition to the browse viewport existing row firsttrue
if
operation was successful.logical setRepositionedRow(long row, java.lang.String cond)
row
- 1-based row number where the new record is displayedcond
- If this parameter is "conditional", then method tries to
reposition to the browse viewport existing row firsttrue
if
operation was successful.logical isScrollable()
void setScrollable(logical scroll)
scroll
- The new value for the SCROLLABLE attribute.void setScrollable(boolean scroll)
scroll
- The new value for the SCROLLABLE attribute.void setSeparators(boolean separators)
separators
- New value for the attribute.void setSeparators(logical separators)
separators
- New value for the attribute.logical isSeparators()
true
if row and column separators of the browse widget are displayed.handle getBrowseColumn(int index)
index
- 1-based column index.handle getBrowseColumn(NumberType index)
index
- 1-based column index.integer getSeparatorFgColor()
integer getColumnFgColor()
integer getColumnBgColor()
void setSeparatorFgColor(long color)
color
- The new value for the attribute.void setSeparatorFgColor(int64 color)
color
- The new value for the attribute.void setColumnFgColor(long color)
color
- The new value for the attribute.void setColumnFgColor(int64 color)
color
- The new value for the attribute.void setColumnBgColor(long color)
color
- The new value for the attribute.void setColumnBgColor(int64 color)
color
- The new value for the attribute.integer visibleIterations()
void setNoValidate(boolean value)
value
- The new value for the attribute.void setNoValidate(logical value)
value
- The new value for the attribute.logical isNoValidate()
void setAutoValidate(boolean value)
value
- The new value for the attribute.void setAutoValidate(logical value)
value
- The new value for the attribute.logical isAutoValidate()
handle getCurrentColumn()
true
).void setCurrentColumn(handle columnHandle)
true
).columnHandle
- Handle to the new current column.logical setSortArrow(int columnIndex, boolean ascending)
columnIndex
- 1-based index of the column.ascending
- true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).true
on success.logical setSortArrow(int columnIndex, boolean ascending, int sortNumber)
columnIndex
- 1-based index of the column.ascending
- true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).sortNumber
- Sort-level for the browse column. 0
to hide the sort-level number,
otherwise numbers from 1
to 9
are allowed.true
on success.logical setSortArrow(int64 columnIndex, logical ascending)
columnIndex
- 1-based index of the column.ascending
- true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).true
on success.logical setSortArrow(int64 columnIndex, logical ascending, int64 sortNumber)
columnIndex
- 1-based index of the column.ascending
- true
for ascending sorting (arrow up). false
for
descending sorting (arrow down).sortNumber
- Sort-level for the browse column. Unknown or 0
to hide the sort-level
number, otherwise numbers from 1
to 9
are allowed.true
on success.logical clearSortArrows()
true
.logical scrollToCurrentRow()
The position of the scrolled row is the first row in the browse viewport, unless the current row is already visible. In this case, the current row remains in the original position.
true
if the row is successfully scrolled into view (or if the scroll is
unnecessary).logical scrollToSelectedRow(int selectedRowIndex)
selectedRowIndex
- Selected row within the browse. A numbered list of selected rows, starting at 1 is
maintained. When the SCROLL-TO-SELECTED-ROW(n)
method is encountered,
the list is iterated to find the nth selected row.true
if the row is successfully scrolled into view (or if the scroll
is unnecessary).logical scrollToSelectedRow(NumberType selectedRowIndex)
selectedRowIndex
- Selected row within the browse. A numbered list of selected rows, starting at 1 is
maintained. When the SCROLL-TO-SELECTED-ROW(n)
method is encountered,
the list is iterated to find the nth selected row.true
if the row is successfully scrolled into view (or if the scroll
is unnecessary).