Browse (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.ui.client.widget.AbstractWidget<O>
- - com.goldencode.p2j.ui.client.widget.AbstractContainer<O>
  - - com.goldencode.p2j.ui.client.FixedSizeContainer<O>
    - - com.goldencode.p2j.ui.client.Browse<O>

All Implemented Interfaces:

FocusListener, KeyListener, Container<O>, Widget<O>, WidgetWithConfig<BrowseConfig>, ConfigOwner<BrowseConfig>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.util.EventListener

Direct Known Subclasses:

BrowseGuiImpl, BrowseImpl
```
public abstract class Browse<O extends OutputManager<?>>
extends FixedSizeContainer<O>
implements WidgetWithConfig<BrowseConfig>, FocusListener, KeyListener
```
Implementation of Progress BROWSE widget. TODO: Do we handle options like NO-ASSIGN, NO-VALIDATE, and VALIDATE functions?

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`Browse.InsertRowInfo` Container for storing information between new row insertion stages.
`protected static class`	`Browse.RowLeaveResult` Result of ROW-LEAVE trigger execution containing result of its execution and information about specific actions that took place during the trigger execution.
`protected static class`	`Browse.SelectedRow` Container which holds row index and row availability (i.e.
`class`	`Browse.SelectionSet` Set of the selected rows for multi-selection.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Widget`	`activeEditor` Reference to the active in-place editor if edit is in progress.
`private boolean`	`awaitingEndError` Waiting for END-ERROR key after edit mode validation error
`protected BrowseModel`	`browseModel` A data model instance.
`protected BrowseTriggerStateHandler`	`browseStateHandler` The browse state handler
`static int`	`CACHE_SIZE` The size of data cache in screen pages.
`Color`	`colorCommon` Terminal attribute for normal text.
`Color`	`colorCurrent` Terminal color for current text.
`protected Color`	`colorHSep` Terminal color for normal text in data area when separators are active.
`private int`	`columnEntryTriggerDepth` Depth of column ENTRY triggers invocation (when we have APPLY "ENTRY" in a column ENTRY trigger).
`private BrowseColumnConfig[]`	`columnsCache` Cache of all columns.
`protected boolean`	`columnsInUpdate` Indicates that the column update procedure is in progress (i.e.
`protected BrowseConfig`	`config` Component attribute container.
`protected int`	`currColumn` Index of current column.
`private int`	`currentRow` 0-based index of the current row in the browse model.
`private boolean`	`currentRowAvail` Determines if the current row was available (could be fetched) at the moment it has become the current row.
`protected RowDisplayStrategy`	`currentRowDisplayStrategy` If we are getting new rows, specifies type of action for which browse rows are fetched and defines how rows are iterated / displayed.
`protected boolean`	`currRowSelected` Determines if the current row is selected (single-selection mode only).
`protected BaseDataType[]`	`currRowUpdates` An updated data for the current row.
`protected BrowseRow[]`	`dcData` Cached rows from the data model.
`protected boolean`	`drawLabels` Draw labels.
`protected BrowseRow`	`editedRow` Contents and cached text of the edited row.
`protected java.lang.Integer`	`editingExistingRowBefore` If editing is active, the index (in the browse model) of the closest exiting row before the currently edited new row.
`private boolean`	`firstEditing` `true` if there has been no in-cell editing.
`protected boolean`	`hadDraw` Set to true if browse was drawn at least once.
`protected boolean`	`hadRowSelected` Determines if a row was selected before regardless of current selection
`protected int`	`ilFirstScrollCol` The minimal positive value of `scrollColumn`.
`protected int`	`ilLabelsHeight` The height (in character rows) of the labels area not including the separator line.
`private boolean`	`initialDataSetObtained` `true` if the rows data set was already fetched for the first time.
`protected java.lang.Integer`	`initialRow` If the query was repositioned before the rows data set was fetched for the first time, then this variable keeps the current row.
`protected boolean`	`inRowLeaveTrigger` `true` if we are in a ROW-LEAVE trigger.
`protected boolean`	`insertingRow` `INSERT-ROW` consists of two stages.
`protected Browse.InsertRowInfo`	`insertRowInfo` Information to be passed between the stages of `INSERT-ROW`.
`protected BrowseRow[]`	`intermediateDcData` Cache of current rows supplemented with "intermediate" rows (i.e.
`protected boolean`	`keepEditingColumn` If `INSERT-ROW` is happening and this variable is `true`, keep the current editing column when the new row is added rather than reset it to the first editable column.
`protected BrowseRow`	`lastRowSelected` Last row that was selected, null if no selection was made but still holds the reference even if deselected or not in the browse anymore
`protected boolean`	`layoutNotificationSent` `true` if server has been notified that layout on the client side has been performed.
`private static CentralLogger`	`LOG` logger
`protected boolean`	`navigable` After initial enabling of browse it becomes navigable.
`protected int`	`NEW_ROWS_NUMERATION_START` Index of the first added new row.
`private int`	`newRowNumber` Next unique row number for a new row.
`private java.util.Map<java.lang.Integer,java.lang.Integer>`	`ordinalToVisibleMap` Map of columns' 0-based ordinals among all columns to 0-based ordinals of these columns among visible columns.
`protected double`	`originalHeight` Height of browse as it was passed to `AbstractContainer.setSize(double, double)`.
`protected double`	`originalWidth` Width of browse as it was passed to `AbstractContainer.setSize(double, double)`.
`protected boolean`	`pendingExtraRowFetch` If `true`, then the browse will fetch an extra row on the next scroll operation in order to determine if one- or multi-page scrolling mode should take place.
`protected boolean`	`pendingRowLeaveSave` This flag is related to handling of APPLY LASTKEY (or APPLY navigation-event) statement inside ROW-LEAVE trigger.
`protected boolean`	`pseudoFocus` This variable is used to reproduce special drawing behavior for case when query is initialized after browse is displayed first time.
`protected boolean`	`queryClosed` Flag which helps to distinguish if `queryRepositioned(boolean, int)` was caused by query opening or repositioning.
`private boolean`	`queryInitialized` `true` if an initial query was assigned to the browse.
`protected java.lang.String[]`	`rcLabels` Rendered columns labels area.
`protected int`	`rowCountAssessment` The number that allows to assess if the total number or rows in the result set is more or less than the page size.
`private int`	`rowEntryTriggers` Count the number of currently invoked ROW-ENTRY triggers
`protected boolean`	`savingRow` `true` if we are in the process of saving of the edited row.
`protected int`	`scrollColumn` The data model index of the scroll anchor column.
`protected Browse.SelectionSet`	`selectedRowIndices` Indexes of selected rows in `Integer` form.
`boolean`	`separatorQuirk` Set to `true` when separators need to be underscored.
`private BrowseColumnConfig[]`	`visibleColumnsCache` Cache of visible columns.

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget
listeners, location, mousePtr, nativeInsets, physicalLocation

Constructor Summary

Constructors
Constructor and Description

Browse(WidgetId id, BrowseConfig cfg)
Constructs the Browse widget.

Constructors
Constructor and Description
`Browse(WidgetId id, BrowseConfig cfg)` Constructs the Browse widget.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`acceptTrigger(int eventCode)` Tests if the target event can be triggered or not.
`protected abstract void`	`addEditor(Widget editor)` Add editor widget to the browse.
`protected int`	`addNewRow(int rowIndex, BaseDataType[] rowData, int viewportRow, boolean after)` Add new row to the cache.
`protected boolean`	`advanceCurrRowOrSelection(boolean advanceSelection, boolean forward, boolean handleEditing, int rowIndex)` Works in two modes: Advance current row - make the row before or after the current row the new current row. Advance selection - deselected all rows and make the row before or after the specified row selected.
`protected boolean`	`advanceRowSelection(boolean forward)` Worker for `selectNextRow()` and `selectPreviousRow()`.
`void`	`afterConfigUpdate(BrowseConfig beforeUpdate)` The method is called after the configuration associated with the owner changes.
`void`	`applyEnhancedConfigClient()` Run client-side part of the code which should be executed after an enhanced configuration is applied to the browse.
`int`	`calcDown(int rowHeightPixels)` Calculate DOWN value for the browse basing on the given row height.
`static boolean`	`cellStartsWith(java.lang.String cellText, char searchChar)` Returns `true` if the visual representation of the cell content starts with the given character.
`protected boolean`	`checkChuiRowInView()` For ChUI: if the current row is not in the view, set the top row in the view as the current row.
`void`	`checkDeleteEntryRowIndex()` Check that the current row can be deleted with DELETE-RESULT-LIST-ENTRY: the row should be existing and in the view.
`protected void`	`cleanupEditor(Widget editor)` Clean up editor widget.
`boolean`	`clearWidget()` Clear widget state on CLEAR FRAME call for the parent frame.
`protected abstract void`	`columnToView(int visibleColumnIndex)` Setups scrolling to fully (as possible) show the given column.
`void`	`completeTrigger(int eventCode)` Manages the internal state after the trigger is finished.
`protected void`	`conditionalPendingExtraRowFetch()` If the top row in the view is the first row in the result set, set the `pendingExtraRowFetch` flag, which makes browse fetch an extra row on the next scroll in order to determine if one- or multi-page scrolling mode should take place.
`BrowseConfig`	`config()` Provide access to the attributes stored in the widget.
`protected FillIn`	`createEditingFillIn(boolean useValue, BaseDataType value)` Create fill-in editor widget for the current column.
`protected Widget`	`createEditor(boolean useValue, BaseDataType value)` Create editor fill-in for the current column.
`Widget<O>`	`currentFocus()` Returns the same as `getDefaultFocus()` because focus placement inside BROWSE can't be switched from initial component until subcomponent creation or deletion.
`protected BrowseRow`	`dcGetRow(int rowIndex)` Returns the cached row with the given index.
`protected BaseDataType[]`	`dcGetRowData(int rowIndex)` Returns the row data with the given index.
`protected int`	`dcGetRowIndex(int rowIndex)` Calculate row index for internal cache.
`private void`	`dcUpdateRow(int rowIndex, int[] cellIndices, BaseDataType[] cellValues, boolean updateModel, boolean rowInView, BrowseRow editedRowData)` Updates row in the cache and the model.
`Widget<O>`	`defaultFocus()` Returns this component directly if there is no in-place editor.
`void`	`deselectAll()` Remove all selections.
`void`	`deselectFocusedRow()` Deselect row which is currently in focus.
`boolean`	`deselectSelectedRow(int rowIndex)` Implements the DESELECT-SELECTED-ROW() widget method.
`void`	`destroy()` Destroy this widget.
`protected void`	`displayErrorMessage(java.lang.String message)` Display browse-related error message.
`void`	`doLayout()` Lay out the browse.
`abstract void`	`draw()` Draws the widget: border, header, selection marks and line, internal FillIn etc.
`abstract void`	`drawCaret()` Sets position of terminal's cursor.
`void`	`executePendingRefresh(boolean queryReopened, boolean repositionBeforeReopen, int repositionedRow)` Execute pending refresh when REFRESHABLE is turned on.
`void`	`finishStopEdit()` Stops the current editor.
`void`	`fireDefaultAction()` Fires the DefaultAction event.
`void`	`fireValueChanged()` Fires the ValueChanged event.
`boolean`	`focusTraversable()` This component will receive an input focus when Tab or Shift-Tab is pressed.
`protected static java.lang.String`	`generateQuestionMarks(BrowseColumnConfig columnConfig, BaseDataType var)` Generate question marks that indicate that the cell value cannot be displayed using the current format.
`protected ComboBox`	`getActiveComboBox()` Get active editor (assumes it is a combo-box).
`protected Widget`	`getActiveEditor()` Returns the active in-place editor if edit is in progress.
`protected FillIn`	`getActiveFillIn()` Get active editor (assumes it is a fill-in).
`protected ToggleBox`	`getActiveToggleBox()` Get active editor (assumes it is a toggle-box).
`abstract int`	`getBrowseColumnY()` Get value of `column.Y` attribute for the columns of this browse: vertical offset of the current row from the top of the browse, in pixels for GUI or in chars for ChUI.
`protected int`	`getCachedRowNumber(BrowseRow[] rowCache, int rowIndex)` Get the browse model index of the data row at the specified row index in the specified row cache.
`int`	`getCachedRowNumber(int viewportIndex)` Get the browse model index of the data row positioned at the specified viewport row.
`int`	`getCachedRowNumberWithIntermediate(int viewportIndex)` Get the browse model index of the data row in the row cache supplemented with "intermediate" rows (`intermediateDcData`), positioned at the specified viewport row.
`int`	`getCacheSize()` Get the number of rows in the cache (which matches the number of rows in the viewport).
`int`	`getCacheSizeWithIntermediate()` Get the number of rows in the cache supplemented with "intermediate" rows (`intermediateDcData`), which matches the number of rows in the viewport.
`static java.lang.String`	`getCellText(BrowseColumnConfig columnConfig, BaseDataType var)` Get cell text to render.
`static java.lang.String`	`getCellTextNoError(BrowseColumnConfig columnConfig, BaseDataType var)` Get cell text to render, without raising error.
`BrowseColumnConfig`	`getColumnCfg(int columnOrdinal)` Return `BrowseColumnConfig` for specified index.
`int`	`getColumnCount()` Get the number of columns.
`protected BrowseColumnConfig[]`	`getColumns()` Return information about all columns regardless of their visibility.
`java.lang.String`	`getColumnText(int columnOrdinal)` Get text value of the given column in current row.
`BaseDataType`	`getColumnValue(int columnOrdinal)` Get value of the given column in current row.
`BrowseColumnConfig`	`getCurrentColumn()` Get the currently editing column.
`int`	`getCurrentRow()` Get the current row.
`protected Browse.SelectedRow`	`getCurrentRowAsSelected()` Get the current row as `Browse.SelectedRow` object which takes into account its availability (see `currentRowAvail`).
`static DisplayFormat`	`getDisplayFormat(BrowseColumnConfig colCfg)` Get display format which corresponds to format string and data type stored in configuration.
`int`	`getDown()` Return number of potential data rows in the `Browse`.
`protected int`	`getEdgeExistingRow(boolean first)` Get first or last existing (not new) row in the view.
`protected WidgetConfig`	`getEditorConfig(int columnOrdinal)` Get configuration of the editor (fill-in, toggle-box or combo-box) used for in-browse editing for the target column.
`protected int`	`getEditorCursorOffset()` Return the cursor offset from the left bound of the current in-cell editor.
`protected BaseDataType`	`getEditorValue()` Get value of the editor widget.
`private int`	`getFirstEditableColumn()` Get the first editable column in the browse.
`protected int`	`getFirstExistingRow()` Get first existing (not new) row in the view.
`integer`	`getFocusedRow()` Implements the FOCUSED-ROW attribute getter.
`Widget`	`getFocusedWidget()` Returns the widget which corresponds the FOCUS handle if this browse is focused.
`int[]`	`getIdsOfColumnWidgets()` Get widget IDs of the browse column widgets.
`BrowseColumnConfig[]`	`getInvisibleColumns()` Return information about invisible columns.
`static java.lang.String[]`	`getLabelVar(BrowseColumnConfig colCfg)` Return label as array of strings.
`protected int`	`getLastAvailableSelectedRow(boolean includeNewRows)` Get last (in the order of selection) "available" (not deleted on the moment of selection) selected row.
`protected int`	`getLastExistingRow()` Get last existing (not new) row in the view.
`int`	`getMaximalSelectedRowIndex()` Get the maximal row index (in the browse model) among the selected rows,
`BrowseModel`	`getModel()` Get currently used `BrowseModel`.
`protected int`	`getNewRowsBefore(int baseViewportRow)` Get the number of new rows in the viewport before the given base viewport row.
`BrowseColumnConfig`	`getNextColumn(BrowseColumnConfig column)` Return reference to next column relative to given column.
`protected int`	`getNumberForLastRow()` Get a big number that can be used in `getRows(int, int, boolean, RowDisplayStrategy)` to make it return the last row in the result set.
`protected int`	`getPageSize()` Get page size used for Page Up / Page Down.
`BrowseColumnConfig`	`getPrevColumn(BrowseColumnConfig column)` Return reference to previous column relative to given column.
`int`	`getRepositionedRow()` Get repositioned row.
`private int`	`getRowDeletionShift(int baseRow)` Get the number of non-new selected rows before the given base row.
`protected int`	`getRowDisplayTriggerId()` Get ID of the ROW-DISPLAY trigger for this browse.
`protected BrowseRow[]`	`getRows(char searchChar, int searchColumn, int viewportTopRow, int viewportBottomRow)` This function is used when search by key is performed in a browse.
`protected BrowseRow[]`	`getRows(int startRowIndex, int count, boolean forward, RowDisplayStrategy displayStrategy)` Retrieves several subsequent rows from the database.
`protected ScreenBuffer[]`	`getScreenBufferForTrigger(int triggerId)` Get screen buffer that can be used for trigger invocation on server side.
`protected int`	`getScrollRow()` Get the index of the row on the top of the page.
`int`	`getSelectedRowIndex(int selIndex)` Get the index (in the browse model) of the given selected row.
`int`	`getSelectedRowIndex(int selIndex, boolean ignoreNotAvail, boolean newAsAvail)` Get the index (in the browse model) of the given selected row.
`int[]`	`getSelectedRowIndexes()` Retrieve the row indexes of the selected rows in the given browse widget.
`int`	`getSelectedRowsCount()` Returns the count of selected rows.
`static BrowseTextAlignment`	`getTextAlign(BrowseColumn column)` Get browse column text alignment.
`static BrowseTextAlignment`	`getTextAlign(BrowseColumnConfig columnConfig)` Get browse column text alignment.
`BaseDataType`	`getValue()` Getting the BaseDataType object representing the current value.
`protected BaseDataType`	`getValue(int columnOrdinal)` Get value for the specified column.
`protected BaseDataType`	`getValue(int columnOrdinal, boolean useSelection)` Get value for the specified column.
`int`	`getViewportRow()` Get the index of the current row in the viewport.
`int`	`getViewportRow(int rowIndex)` Get the index of the specified row in the viewport.
`protected BrowseColumnConfig`	`getVisibleColumnCfg(int visibleColumnIndex)` Return `BrowseColumnConfig` for specified index.
`int`	`getVisibleColumnCount()` Get the number of visible columns.
`protected BrowseColumnConfig[]`	`getVisibleColumns()` Return information about visible columns.
`protected boolean`	`goDown()` Scroll one row up and adjust current row.
`protected boolean`	`goDown(boolean handleEditing, boolean fireValueChanged, boolean startFromSave)` Scroll one row down and adjust current row.
`protected boolean`	`goDownWithSelection(int rowIndex)` Deselect all rows and select the row after the given one.
`protected boolean`	`goUp(boolean handleEditing)` Scroll one row up and adjust current row.
`protected boolean`	`goUp(boolean handleEditing, boolean fireValueChanged, boolean startFromSave)` Scroll one row up and adjust current row.
`protected boolean`	`goUpWithSelection(int rowIndex)` Deselect all rows and select the row before the given one.
`protected void`	`handleTabKey()` Handle TAB key press.
`boolean`	`hasFocusable(boolean next, Widget<O> exclude)` Reports if there is at least 1 focusable column that is not the current column.
`boolean`	`hasFocusable(Widget<O> exclude)` Reports if there is at least 1 focusable component that is not the given component.
`boolean`	`hasRowMarkers()` If the browse has row markers drawn.
`boolean`	`hasRows()` Gets a value that indicates whether the browse contains one or more rows (including new rows).
`protected boolean`	`incrementalScroll(int rowCount)` Scroll browse by the specified number of rows.
`protected boolean`	`incrementalScroll(int rowCount, boolean forceTrailingSpace, boolean incrementalRowDisplay, boolean triggeredByScrollbar)` Scroll browse by the specified number of rows.
`protected abstract void`	`initEditorConfig(BaseConfig cfg)` Initialize editor widget config.
`void`	`initialize(WidgetId id, BrowseConfig cfg)` Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
`void`	`initQueryAssigned()` Second stage of the initialization of the Browse widget which is performed only when query is initially assigned.
`protected BrowseRow[]`	`insertEditingRow(BrowseRow[] serverData, boolean forward, int maxSize, int lastRow, boolean allowBeforeFirst)` If a new row is being edited, add this row into the given result set if it should be in this set.
`boolean`	`insertRow(boolean after)` Inserts a blank row in an updateable browse before or after the last selected row.
`void`	`insertRowSecondPart()` Second part of `insertRow(boolean)` processing, which is usually executed after the trigger containing the `INSERT-ROW` call, finishes.
`boolean`	`invokeLeaveCellTrigger(WidgetId nextFocus)` Invoke the LEAVE trigger for the currently editable column.
`boolean`	`invokeRowEntryTrigger()` Invoke ROW-ENTRY trigger.
`boolean`	`invokeRowEntryTrigger(WidgetId leaveWidgetId)` Invoke ROW-ENTRY trigger.
`Browse.RowLeaveResult`	`invokeRowLeaveTrigger(WidgetId nextId)` Invoke ROW-LEAVE trigger.
`protected boolean`	`isAggressiveCurrentRowSelection()` Returns `true` if the current row of the single-selection browse is selected on FOCUS-GAINED and some other events.
`private boolean`	`isAnyRowSelected()` Returns `true` if the browse has any selected row, `false` otherwise.
`boolean`	`isConditionalReposition()` Returns reposition mode set be SET-REPOSITIONED-ROW.
`boolean`	`isCurrentRowInView()` Determine if the current row is in the view.
`boolean`	`isCurrentRowModified()` Return status of the updates of the current row.
`boolean`	`isEditing()` Returns `true` if editing is in progress.
`boolean`	`isEditorComboBox()` Returns `true` if the current editor is a combo-box.
`protected boolean`	`isEditorFillIn()` Returns `true` if the current editor is a fill-in.
`protected boolean`	`isEditorModified()` Returns `true` if the widget value was modified.
`protected boolean`	`isEditorToggleBox()` Returns `true` if the current editor is a toggle-box.
`boolean`	`isEditPossible()` Determine if in-browse editing is possible.
`protected boolean`	`isFirstBrowseRow()` Determines if the current row is the first browse row, i.e.
`protected boolean`	`isFirstLastRowCopyQuirk()` Determine if this browse should have the following quirk: is a new row is inserted before the first row or after the last row, the value of the current column is copied from the first/last row to the new row.
`boolean`	`isFocusedRowSelected()` Return `true` if row which has focus is selected.
`boolean`	`isInColumnEntryTrigger()` Returns `true` if an column ENTRY trigger is running.
`boolean`	`isInsertingRow()` Returns the current stage of insert-row operation.
`boolean`	`isLayoutMode()` Returns `true` if browse layout mode is active.
`boolean`	`isModified(int columnOrdinal)` Check if the value in specified column in current row is changed.
`protected boolean`	`isNewEditingRowOutOfTheView()` Returns `true` if there is a new editing row which is out of the view.
`boolean`	`isNewRow()` Returns `true` if the current row is a new row and is not present in the database.
`boolean`	`isNewRow(int newRowIndex)` Returns `true` if the given row is a new row and is not present in the database.
`protected boolean`	`isNoEdit()` Checks if entering edit mode is prevented while updating browse content on enhanced dynamic sort and filtering.
`protected boolean`	`isOnePageScrollingMode()` 4GL has two scrolling modes: "one-page" scrolling mode which is used if the total number of rows is less or equal the page size and the "multi-page" mode.
`protected boolean`	`isRefreshedOnEnable()` Determines if browse refreshed on browse widget enabling.
`boolean`	`isRowInView(int rowIndex)` Determines if the specified row is in the viewport.
`boolean`	`isRowSelected(int rowIndex)` Returns is given row selected.
`boolean`	`isSavingRow()` Returns `true` if we are in the process of saving of the edited row.
`boolean`	`isSelectedRowAvailable(int selIndex, boolean newAsAvailable)` Determines if the specific selected row was available (could be fetched) at the moment of its selection.
`boolean`	`isSelectionMultiple()` Returns selection mode state.
`protected boolean`	`isViewportEdge(int rowIndex, boolean forward)` Determines if the specified row is the first or last row in the view.
`protected Browse.RowLeaveResult`	`leaveRow()` Release current row (finish editing and commit).
`protected Browse.RowLeaveResult`	`leaveRow(boolean startFromSave)` Release current row (finish editing and commit).
`protected Browse.RowLeaveResult`	`leaveRow(boolean startFromSave, WidgetId nextId)` Release current row (finish editing and commit).
`void`	`moveColumn(int srcIndex, int destIndex)` Implements the client side of the MOVE-COLUMN() widget method.
`boolean`	`needsInsertRowContinueOnEntry(BrowseColumn entryColumn)` Returns `true` if we need to perform the second stage of `INSERT-ROW` immediately, as a reaction to browse column "entry" event.
`void`	`nextFocus()` This method is called from the in-place editor when it need to initiate switching to the next widget.
`protected int`	`nextNewRowNumber()` Get next unique row number for a new row.
`protected void`	`notifyBrowseScrolled()` Notify that the browse has been scrolled (i.e.
`void`	`notifyColumnsUpdated()` Notify the browse that some columns have been added to it or visibility of columns has been changed.
`abstract void`	`notifyColumnsUpdated(boolean refreshData)` Notify the browse that some columns have been added to it or visibility of columns has been changed.
`void`	`notifyKeyPressedInEditor(KeyInput key)` Notify the browse that the key was pressed when the editor is in focus.
`private void`	`notifyRowReleased()` Notify server that the row has been released.
`void`	`onFocusGained(FocusEvent event)` Handle situation when `Browse` widget receives the focus.
`void`	`onFocusLost(FocusEvent fe_)` Handle situation when `Browse` widget loses the focus.
`void`	`onKeyPressed(KeyInput event)` Process key event.
`void`	`onKeyTyped(KeyInput event)` Handles ' ' key in R/O mode: fires ValueChanged event.
`protected java.lang.Integer`	`ordinalToVisible(int columnOrdinal)` Get 0-based index of the column among the visible columns.
`void`	`parentFrameViewed()` Notify browse that the parent frame became visible.
`protected void`	`populateColumnsCache()` Populate cache of columns using updated `BrowseConfig.columnIds`.
`void`	`prevFocus()` This method is called from the in-place editor when it need to initiate switching to the previous widget.
`void`	`processEvent(Event evt)` Intercept special events.
`void`	`queryClosed()` Reset the cache and redisplay.
`void`	`queryRepositioned(boolean repositionError, int targetRepositionRow)` Notify the browse that the underlying query has been repositioned.
`void`	`refresh(boolean deleteCurrentRowMode)` Refresh the browse cache and redisplay the browse.
`void`	`refreshAfterDeletion(int rowIndex)` Refresh the browse after some of its rows were deleted.
`protected abstract void`	`refreshColumnAttributes(BrowseColumnConfig config, CellAttributes attributes)` Refresh column attributes which are cell-specific (like @BGCOLOR@ or @FGCOLOR@) for the specific column, with the cell data from the rows cache.
`protected void`	`refreshColumnsAttributes()` Refresh column attributes which are cell-specific (like @BGCOLOR@ or @FGCOLOR@) for all columns, with the cell data from the rows cache.
`void`	`refreshCurrentRow(BrowseRow row)` Refresh the current browse row using the provided data.
`void`	`refreshScrollRow(boolean leaveOnRowInView, boolean preserveViewportRow)` Refresh scroll row in the browse and redisplay.
`void`	`refreshScrollRow(boolean leaveOnRowInView, boolean preserveViewportRow, boolean repositioned, boolean repositionError, int targetRepositionRow, boolean leaveOnOnePageMode)` Refresh scroll row in the browse and redisplay.
`void`	`refreshScrollRow(int scrollRow, boolean leaveOnRowInView, boolean preserveViewportRow)` Refresh scroll row in the browse and redisplay.
`void`	`refreshScrollRow(int scrollRow, boolean leaveOnRowInView, boolean preserveViewportRow, boolean repositioned, boolean repositionError)` Refresh scroll row in the browse and redisplay.
`void`	`refreshScrollRow(int scrollRow, boolean leaveOnRowInView, boolean preserveViewportRow, boolean repositioned, boolean repositionError, int targetRepositionRow, boolean leaveOnOnePageMode)` Refresh scroll row in the browse and redisplay.
`protected Browse.RowLeaveResult`	`releaseCurrentRow()` Finishes editing and commits row to model if some updates are available.
`private Browse.RowLeaveResult`	`releaseCurrentRow(boolean updateModel, boolean triggerRowLeave, boolean startFromSave)` Finishes editing and commits row to model if some updates are available.
`private Browse.RowLeaveResult`	`releaseCurrentRow(boolean updateModel, boolean triggerRowLeave, boolean startFromSave, WidgetId nextId)` Finishes editing and commits row to model if some updates are available.
`void`	`removeFromSelection(int deletedRowIndex)` Remove given row(s) from the set of selected rows.
`void`	`requestFocus()` Requesting the focus to the `Browse`.
`void`	`requestFocus(boolean force, boolean mouse)` Request focus.
`protected void`	`resetColumnsCache()` Reset cached information about columns.
`void`	`resetColUpdatesInCurrentRow(int col)` Reset current row updates for a column.
`void`	`resetFirstEditing()` Set `firstEditing` flag to `false`.
`private void`	`resetModifiedFlags()` Reset the modified flags.
`void`	`rowEntryCreated(int newRowId)` Performs client-side actions after a new row has been added to the backing result set using CREATE-RESULT-LIST-ENTRY.
`void`	`rowEntryDeleted(int deletedRowId)` Performs client-side actions after a row has been deleted from the backing result set using DELETE-RESULT-LIST-ENTRY.
`private boolean`	`saveCurrentRow(boolean updateModel)` Saves the current row into cache and data model.
`void`	`scrollToCurrentRow()` Scrolls a browse (if necessary) to bring the currently selected row into view.
`protected void`	`scrollToEditableRow()` Scroll to the editable row if it is out of the view.
`protected boolean`	`scrollToRow(int scrollRow)` Scroll to the specified row (all records are refreshed).
`protected boolean`	`scrollToRow(int scrollRow, boolean setAsCurrentRow)` Scroll to the specified row (all records are refreshed).
`protected boolean`	`scrollToRow(int scrollRow, boolean setAsCurrentRow, boolean leaveOnNoRows)` Scroll to the specified row (all records are refreshed).
`protected boolean`	`scrollToRow(int scrollRow, boolean setAsCurrentRow, boolean leaveOnNoRows, boolean ignoreOnePageScrollingMode)` Scroll to the specified row (all records are refreshed).
`protected boolean`	`scrollToRow(int scrollRow, boolean setAsCurrentRow, boolean leaveOnNoRows, boolean ignoreOnePageScrollingMode, boolean honorRepositionedRow)` Scroll to the specified row (all records are refreshed).
`protected boolean`	`scrollToRow(int scrollRow, boolean setAsCurrentRow, boolean leaveOnNoRows, boolean ignoreOnePageScrollingMode, boolean honorRepositionedRow, boolean allowStartEdit)` Scroll to the specified row (all records are refreshed).
`protected boolean`	`scrollToRow(int scrollRow, boolean setAsCurrentRow, boolean leaveOnNoRows, boolean ignoreOnePageScrollingMode, boolean honorRepositionedRow, boolean allowStartEdit, int oneTimeRepositionedRow, boolean updateSelection)` Scroll to the specified row (all records are refreshed).
`void`	`scrollToSelectedRow(int selectedRowIndex)` Scrolls a browse (if necessary) to bring the specified selected row into view.
`void`	`selectAll()` Select all rows.
`void`	`selectFocusedRow()` Select row which is currently in focus.
`boolean`	`selectNextRow()` Implements the SELECT-NEXT-ROW() widget method.
`boolean`	`selectPreviousRow()` Implements the SELECT-PREV-ROW() widget method.
`boolean`	`selectRow(int rowIndex)` Implements the SELECT-ROW() widget method.
`private void`	`setColumnEditMode(boolean mode)` Changes the flag indicating the browse column is in editing mode.
`void`	`setColumnValue(int columnOrdinal, BaseDataType value, java.lang.String fmt)` Set value for the given column in current row.
`void`	`setCurrentColumn(int columnOrdinal)` Set the currently editing column.
`void`	`setCurrentColumnId(BrowseColumn column)` Set `BrowseConfig.currentColumnID`, which effectively updates `CURRENT-COLUMN` on the server side.
`protected void`	`setCurrentRow(int currRow)` Set the current row.
`private void`	`setCurrentRow(int currRow, boolean allowDeletedRow)` Set the current row.
`protected void`	`setCurrentRow(int currRow, boolean updateSelection, boolean allowDeletedRow)` Set the current row.
`protected boolean`	`setCurrentRowSelected()` Select current row for single-selection case.
`protected void`	`setEditorCursorOffset(int cursorOffset)` Set the cursor offset for the current in-cell editor, if there's an active editor and it is of a type which has a cursor.
`void`	`setEditorReadOnly(boolean readOnly)` If browse is in editing mode, set editor in 4GL READ-ONLY mode.
`protected void`	`setEditorValue(BaseDataType value)` Set value of the editor widget.
`void`	`setEnabled(boolean enabled)` Enable/disable widget.
`void`	`setHighlighted(boolean highlighted)` Tracks the highlighted state of the component.
`void`	`setIntermediateRows(BrowseRow[] rows)` Set "intermediate" rows (i.e.
`void`	`setKeepEditingColumn()` If `INSERT-ROW` is happening, keep the current editing column when the new row is added rather than reset it to the first editable column.
`void`	`setReadOnly(boolean readOnly)` Set READ-ONLY attribute.
`void`	`setSelectionMultiple(boolean multiple)` Switch multiple selection on and off.
`void`	`show()` Show widget.
`boolean`	`startEdit()` Creates an editor for the current cell and adds it to the browse.
`protected boolean`	`startEdit(boolean updateSelection)` Creates an editor for the current cell and adds it to the browse.
`protected boolean`	`startEdit(boolean updateSelection, boolean sendEntry)` Creates an editor for the current cell and adds it to the browse.
`boolean`	`startEdit(WidgetId prevFocus)` Creates an editor for the current cell and adds it to the browse.
`protected boolean`	`startEdit(WidgetId prevFocus, boolean updateSelection, boolean useValue, BaseDataType value)` Creates an editor for the current cell and adds it to the browse.
`protected boolean`	`startEdit(WidgetId prevFocus, boolean updateSelection, boolean useValue, BaseDataType value, boolean sendEntry)` Creates an editor for the current cell and adds it to the browse.
`protected abstract void`	`startEditOnFocusGained(Widget prevFocus)` Starts editing for the editable browse on focus gained event.
`void`	`startTrigger(int eventCode)` Manages the internal state before the trigger is started.
`protected boolean`	`stopEdit(boolean undo, boolean validate)` Finishes edit and destroys an editor.
`boolean`	`stopEdit(WidgetId nextFocus)` Finishes edit and destroys an editor.
`protected boolean`	`stopEdit(WidgetId nextFocus, boolean undo, boolean validate)` Finishes edit and destroys an editor.
`protected boolean`	`stopEdit(WidgetId nextFocus, boolean undo, boolean validate, boolean skipCellLeave)` Finishes edit and destroys an editor.
`protected void`	`switchCurrentRowSelection()` For browse with multiple selection: select current row if it is not selected or deselect if it is selected.
`protected void`	`switchToNextCell()` Switches in-line editor to the next editable cell.
`(package private) void`	`switchToPrevCell()` Switches in-line editor to the previous editable cell.
`void`	`toggleSelectedRows(boolean select, int start, int end)` For multi-selection browse, select or deselect the range of rows.
`protected void`	`triggerOffEnd(boolean noRowsTriggers)` Triggers the OFF-END event when the browse has an open query.
`protected void`	`triggerOffEnd(boolean noRowsTriggers, boolean triggeredByScrollbar)` Triggers the OFF-END event when the browse has an open query.
`void`	`undoValue()` Undo editing operation results and reset everything to initial state.
`boolean`	`undoValue(boolean startEdit)` Undo editing operation results and reset everything to initial state.
`protected boolean`	`updateColumn(int columnOrdinal, BaseDataType var)` Update specified cell in current row.
`protected void`	`updateLabelsHeight()` Update height of the labels area.
`protected void`	`updateMaxDataGuess(boolean lastReached)` Update MAX-DATA-GUESS value which holds estimated number of rows.
`boolean`	`valid()` Browse behaves like simple component in this regard.
`protected boolean`	`validateEditorValue()` Run validation for the current editor.
`private boolean`	`validateStopEdit(boolean undo, boolean validate)` Validates current editor.
`protected int`	`visibleToOrdinal(int visibleColumnIndex)` Get 0-based index of the column among all columns (i.e.

Methods inherited from class com.goldencode.p2j.ui.client.FixedSizeContainer
minimumSize

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer
add, add, add, addContainerStateListener, addDirectly, belongsTo, checkWidget, childrenLocation, clipping, clipRectangle, copyState, currentFocus, cycleFocus, deregisterSelectedWidget, detach, dimension, dumpCurrentWidgets, dumpWidgets, endSizeChange, findMouseSource, firstFocus, focus, focusWorker, formatDump, get, getAllSelectedWidgets, getClipRect, getEffectiveScrollableSize, getFocusInt, getIgnoreFocus, getLayout, getScrollableSize, getTabItemList, height, insets, lastFocus, moveAfterTabItem, moveBeforeTabItem, moveToBottom, moveToBottomInClass, moveToTop, moveToTopInClass, moveToZpos, normalizeZOrder, onWidgetAdded, onWidgetRemoved, paintOnTop, parentOf, prepareWidgets, processKeyEvent, reflectAncestorChange, reflectLocationChanged, registerSelectedWidget, remove, removeContainerStateListener, repaint, replace, requestFocus, setFocus, setFocusInt, setHeight, setIgnoreFocus, setInsets, setLayout, setPhysicalDimensionInt, setSize, setSize, setTabItemList, setWidth, startSizeChange, swap, triggerContainerStateRedrawEnabled, unrealize, updateSizeWorker, widgets, widgetsAsList, widgetStateChanged, width

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget
_setHidden, _setVisible, activateDirectManipulation, addFocusListener, addKeyListener, afterConfigUpdateBase, ancestor, ancestorId, autoResize, bounds, clear, clipRectangle, clipRectangle, clipWith, copyColors, createMouseHoverAction, deactivateDirectManipulation, debug, disable, disableTooltip, displayPhysicalLocation, enable, enableTooltip, enclosingFrame, forceCursorOnFocus, forceVisibility, getActualBounds, getAndResetBitmap, getAndSetBitmap, getBitmapCopy, getCachedScreenLocation, getCachedScreenPhysicalLocation, getCustomMousePointer, getDefaultEvent, getEffectiveMousePointer, getId, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getPortableMouseEventCoordinates, getSelectedText, getState, getTextHeight, getTextHeightNative, getTextHeightNative, getTextWidth, getTextWidth, getTextWidthNative, getTextWidthNative, getVisiblePart, getZOrderClass, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreAction, initialHeight, initialWidth, isCurrent, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDirectManipulationCapable, isDirectManipulationRequired, isDisplayed, isEnabled, isFocusable, isHeader, isMouseDrag, isRealized, isRepaintDisabled, isRMBEntrySupported, isScreenLocationCached, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, manageSystemActions, mouseActions, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, moveToBottom, moveToTop, name, navigable, oleDoDrop, oleDrag, oleDragging, oleStartDragging, onOleDragging, onOleDropEnd, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, prepParentLocation, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyEventForSelectableWidget, processKeyListeners, processMnemonic, processMnemonicImpl, processSystemKey, raiseLegacyMouseEvents, reflectSizeChanged, refresh, registerWidgetListener, repaint, repaint, requestSync, resetBitmap, resizeTo, resolveFont, resolvePopupMenuId, resolveTitleFont, screen, screenDimension, screenHeight, screenLocation, screenPhysicalLocation, screenWidth, setBitmap, setCachedScreenLocation, setCachedScreenPhysicalLocation, setDirectManipulationActive, setHidden, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, showPopupMenu, supportsCustomMousePointer, sync, topLevelWindow, toString, translate, triggerLocationChanged, unregisterWidgetListener, updateSystemParent, widgetRealized, window

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container
widgetsAsList

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget
acceptsEscAsAnyKey, addFocusListener, addKeyListener, ancestor, ancestorId, bounds, canMovetoTop, defaultMousePtr, displayPhysicalLocation, enclosingFrame, enforceDefaultMousePtr, forceCursorOnFocus, forceVisibility, getActualBounds, getCustomMousePointer, getEffectiveMousePointer, getId, getIdForTrigger, getLegacyWidget, getLoadedMousePointer, getMenuMouse, getMouseActions, getMousePosition, getSelectedText, getState, getTriggerWidget, getTriggerWidget, getVisiblePart, getZOrderClass, hasFocus, hasFocus, hasTooltip, hidden, hide, highlighted, ignoreEnable, initialHeight, initialWidth, isCurrent, isCurrent, isDirectManipulable, isDirectManipulationActive, isDirectManipulationActiveOrInUIB, isDisplayed, isDroppable, isEnabled, isFocusable, isHeader, isInitialValueLayout, isLegacyFocus, isProcessProgressEvent, isRealized, isRepaintDisabled, isRMBEntrySupported, isTabStop, isThreeD, isTotallyObscured, isVisible, isVisible, location, maySwitchFocus, moveToBottom, moveToTop, name, navigable, oleDrag, parent, parent, parent, parentObject, parentOrSelf, parentOrSelfObject, physicalBounds, physicalDimension, physicalLocation, postprocessConfig, preventFocusWhenMouseDownEventDefined, processDirectManipulationEvent, processFocusEvent, processKeyListeners, processMnemonic, raiseLegacyMouseEvents, refreshWidget, registerWidgetListener, repaint, repaint, requestSync, resizeTo, resolvePopupMenuId, screen, screenLocation, screenPhysicalLocation, setDirectManipulationActive, setHidden, setLocation, setLocation, setMousePointer, setMousePointer, setParent, setPhysicalLocation, setSensitiveForUIB, setState, setVisible, setWindow, supportsCustomMousePointer, systemFocusGrabbed, topLevelWindow, unregisterWidgetListener, validateDisplayValue, window

Methods inherited from interface java.awt.event.MouseListener
mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased

Methods inherited from interface java.awt.event.MouseMotionListener
mouseDragged, mouseMoved

Methods inherited from interface java.awt.event.MouseWheelListener
mouseWheelMoved

- Field Detail
  - CACHE_SIZE
```
public static final int CACHE_SIZE
```
    The size of data cache in screen pages.
    
    See Also:
    
    Constant Field Values
  - LOG
```
private static final CentralLogger LOG
```
    logger
  - NEW_ROWS_NUMERATION_START
```
protected final int NEW_ROWS_NUMERATION_START
```
    Index of the first added new row. Following new rows have decreasing row numbers.
    
    See Also:
    
    Constant Field Values
  - browseModel
```
protected BrowseModel browseModel
```
    A data model instance.
  - currRowSelected
```
protected boolean currRowSelected
```
    Determines if the current row is selected (single-selection mode only).
  - hadRowSelected
```
protected boolean hadRowSelected
```
    Determines if a row was selected before regardless of current selection
  - lastRowSelected
```
protected BrowseRow lastRowSelected
```
    Last row that was selected, null if no selection was made but still holds the reference even if deselected or not in the browse anymore
  - currColumn
```
protected int currColumn
```
    Index of current column. It is the column where the last edit is performed. Does NOT include invisible columns.
  - currRowUpdates
```
protected BaseDataType[] currRowUpdates
```
    An updated data for the current row. These data are passed to model if focus leaves this row. If the array or some element in it is null then no updates are available for the corresponding cell. Updates come from cell editing or by setting column SCREEN-VALUE.
  - selectedRowIndices
```
protected Browse.SelectionSet selectedRowIndices
```
    Indexes of selected rows in Integer form. Used only in multiple selection mode. This mode is active if and only if this member is not null.
  - scrollColumn
```
protected int scrollColumn
```
    The data model index of the scroll anchor column. Value 0 means the absence of horizontal scrolling. Otherwise this column will occupy the right part of the view window.
  - ilLabelsHeight
```
protected int ilLabelsHeight
```
    The height (in character rows) of the labels area not including the separator line.
  - ilFirstScrollCol
```
protected int ilFirstScrollCol
```
    The minimal positive value of scrollColumn.
  - dcData
```
protected BrowseRow[] dcData
```
    Cached rows from the data model. Cache size matches the number of rows displayed in the viewport.
  - rcLabels
```
protected java.lang.String[] rcLabels
```
    Rendered columns labels area. This cache is reset when horizontal scrolling is performed.
  - config
```
protected BrowseConfig config
```
    Component attribute container.
  - drawLabels
```
protected boolean drawLabels
```
    Draw labels.
  - browseStateHandler
```
protected BrowseTriggerStateHandler browseStateHandler
```
    The browse state handler
  - currentRow
```
private int currentRow
```
    0-based index of the current row in the browse model.
  - currentRowAvail
```
private boolean currentRowAvail
```
    Determines if the current row was available (could be fetched) at the moment it has become the current row.
  - awaitingEndError
```
private boolean awaitingEndError
```
    Waiting for END-ERROR key after edit mode validation error
  - newRowNumber
```
private int newRowNumber
```
    Next unique row number for a new row.
  - hadDraw
```
protected boolean hadDraw
```
    Set to true if browse was drawn at least once.
  - pseudoFocus
```
protected boolean pseudoFocus
```
    This variable is used to reproduce special drawing behavior for case when query is initialized after browse is displayed first time.
  - rowCountAssessment
```
protected int rowCountAssessment
```
    The number that allows to assess if the total number or rows in the result set is more or less than the page size. It matches the number of already fetched rows, i.e. 1-based index of the maximal known row. Equals -1 if the query is closed or we haven't got any rows yet.
  - pendingExtraRowFetch
```
protected boolean pendingExtraRowFetch
```
    If true, then the browse will fetch an extra row on the next scroll operation in order to determine if one- or multi-page scrolling mode should take place.
  - separatorQuirk
```
public boolean separatorQuirk
```
    Set to true when separators need to be underscored.
  - originalWidth
```
protected double originalWidth
```
    Width of browse as it was passed to AbstractContainer.setSize(double, double). Used to recalculate size variables when a new column is added.
  - originalHeight
```
protected double originalHeight
```
    Height of browse as it was passed to AbstractContainer.setSize(double, double). Used to recalculate size variables when a new column is added.
  - editedRow
```
protected BrowseRow editedRow
```
    Contents and cached text of the edited row. Should be saved because if the edited row goes out of the view and then brought back, it doesn't reflect the changes made in database while the row was edited. Contains unmodified row, copied at the time when editing started.
  - savingRow
```
protected boolean savingRow
```
    true if we are in the process of saving of the edited row.
  - layoutNotificationSent
```
protected boolean layoutNotificationSent
```
    true if server has been notified that layout on the client side has been performed. Used for enhanced initialization.
  - colorCurrent
```
public Color colorCurrent
```
    Terminal color for current text. It is displayed in inverse colors.
  - colorHSep
```
protected Color colorHSep
```
    Terminal color for normal text in data area when separators are active. It is displayed with underline.
  - activeEditor
```
protected Widget activeEditor
```
    Reference to the active in-place editor if edit is in progress.
  - insertRowInfo
```
protected Browse.InsertRowInfo insertRowInfo
```
    Information to be passed between the stages of INSERT-ROW.
  - editingExistingRowBefore
```
protected java.lang.Integer editingExistingRowBefore
```
    If editing is active, the index (in the browse model) of the closest exiting row before the currently edited new row. -1 if the new row is first row in the result set. null if a new row is not being edited.
  - colorCommon
```
public Color colorCommon
```
    Terminal attribute for normal text.
  - columnsCache
```
private BrowseColumnConfig[] columnsCache
```
    Cache of all columns.
  - visibleColumnsCache
```
private BrowseColumnConfig[] visibleColumnsCache
```
    Cache of visible columns.
  - ordinalToVisibleMap
```
private java.util.Map<java.lang.Integer,java.lang.Integer> ordinalToVisibleMap
```
    Map of columns' 0-based ordinals among all columns to 0-based ordinals of these columns among visible columns. E.g. if the second column is invisible, the map will be {0 -> 0, 2 -> 1, 3 -> 2}.
  - currentRowDisplayStrategy
```
protected RowDisplayStrategy currentRowDisplayStrategy
```
    If we are getting new rows, specifies type of action for which browse rows are fetched and defines how rows are iterated / displayed.
  - intermediateDcData
```
protected BrowseRow[] intermediateDcData
```
    Cache of current rows supplemented with "intermediate" rows (i.e. the rows that were already fetched in the process of getting new rows).
  - navigable
```
protected boolean navigable
```
    After initial enabling of browse it becomes navigable. Initial enabling can be performed using ENABLE statement or SENSITIVE attribute, regardless of the parent frame visibility (so browse can stay invisible). When a browse becomes navigable is does NOT fetch rows immediately, but it allows initial row fetching using HOME or END events (at least).
  - initialRow
```
protected java.lang.Integer initialRow
```
    If the query was repositioned before the rows data set was fetched for the first time, then this variable keeps the current row.
  - columnsInUpdate
```
protected boolean columnsInUpdate
```
    Indicates that the column update procedure is in progress (i.e. a column is being added or visibility of a column is changing). In this state there may be inconsistency between old dcData contents and the new set of columns.
  - insertingRow
```
protected boolean insertingRow
```
    INSERT-ROW consists of two stages. The first stage is executed immediately and the second - when the trigger finishes. This flag is true if we're between these stages.
  - keepEditingColumn
```
protected boolean keepEditingColumn
```
    If INSERT-ROW is happening and this variable is true, keep the current editing column when the new row is added rather than reset it to the first editable column.
  - queryClosed
```
protected boolean queryClosed
```
    Flag which helps to distinguish if queryRepositioned(boolean, int) was caused by query opening or repositioning.
  - initialDataSetObtained
```
private boolean initialDataSetObtained
```
    true if the rows data set was already fetched for the first time.
  - rowEntryTriggers
```
private int rowEntryTriggers
```
    Count the number of currently invoked ROW-ENTRY triggers
  - columnEntryTriggerDepth
```
private int columnEntryTriggerDepth
```
    Depth of column ENTRY triggers invocation (when we have APPLY "ENTRY" in a column ENTRY trigger).
  - queryInitialized
```
private boolean queryInitialized
```
    true if an initial query was assigned to the browse.
  - firstEditing
```
private boolean firstEditing
```
    true if there has been no in-cell editing.
  - inRowLeaveTrigger
```
protected boolean inRowLeaveTrigger
```
    true if we are in a ROW-LEAVE trigger.
  - pendingRowLeaveSave
```
protected boolean pendingRowLeaveSave
```
    This flag is related to handling of APPLY LASTKEY (or APPLY navigation-event) statement inside ROW-LEAVE trigger. This is a 4GL quirk: when inside such trigger APPLY happens, the original navigation event is suppressed. Be aware that the quirk may behave differently for different navigation events and situations.
    If UP, DOWN, ENTER, TAB or SHIFT-TAB has been pressed, then, if inside the corresponding ROW-LEAVE trigger APPLY LASTKEY is called, then, for the first APPLY call, only the actions starting from row saving are performed (save row, reposition to new row, start edit). And this set of actions is NOT performed for the parent action after ROW-LEAVE finishes. This can be represented by this pseudo-code:
```
 stop edit
 -- ROW-LEAVE starts --
 pendingRowLeaveSave = true
 any in-trigger logic

 -- start APPLY LASTKEY --
 if (pendingRowLeaveSave)
 {
   pendingRowLeaveSave = false
   save row
   reposition to new row
   start edit
 }
 -- end of APPLY LASTKEY --

 any in-trigger logic
 -- ROW-LEAVE ends --
 RowLeaveResult.rowSaved = !pendingRowLeaveSave

 if (!RowLeaveResult.rowSaved)
 {
   save row
   reposition to new row
   start edit
 }
 
```
- Constructor Detail
  - Browse
```
public Browse(WidgetId id,
              BrowseConfig cfg)
```
    Constructs the Browse widget.
    Call initialize(com.goldencode.p2j.ui.WidgetId, com.goldencode.p2j.ui.BrowseConfig) to finish the widget initialization.
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - Configuration data.
- Method Detail
  - notifyColumnsUpdated
```
public void notifyColumnsUpdated()
```
    Notify the browse that some columns have been added to it or visibility of columns has been changed.
  - notifyColumnsUpdated
```
public abstract void notifyColumnsUpdated(boolean refreshData)
```
    Notify the browse that some columns have been added to it or visibility of columns has been changed.
    
    Parameters:
    
    refreshData - true to refresh row data, false to only update UI.
  - refreshColumnAttributes
```
protected abstract void refreshColumnAttributes(BrowseColumnConfig config,
                                                CellAttributes attributes)
```
    Refresh column attributes which are cell-specific (like @BGCOLOR@ or @FGCOLOR@) for the specific column, with the cell data from the rows cache.
    
    Parameters:
    
    config - Column config to be updated.
    
    attributes - Cell attributes data from the rows cache.
  - startEditOnFocusGained
```
protected abstract void startEditOnFocusGained(Widget prevFocus)
```
    Starts editing for the editable browse on focus gained event. If the current row is out of the view the browse is scrolled to bring the row into the view.
    
    Parameters:
    
    prevFocus - Previously focused widget or null.
  - getScrollRow
```
protected int getScrollRow()
```
    Get the index of the row on the top of the page.
    
    Returns:
    
    0-based index (in the browse model) of the row on the top of the page or 0 if there are no rows.
  - isNoEdit
```
protected boolean isNoEdit()
```
    Checks if entering edit mode is prevented while updating browse content on enhanced dynamic sort and filtering.
    
    Returns:
    
    false
  - isLayoutMode
```
public boolean isLayoutMode()
```
    Returns true if browse layout mode is active.
    
    Returns:
    
    false.
  - afterConfigUpdate
```
public void afterConfigUpdate(BrowseConfig beforeUpdate)
```
    The method is called after the configuration associated with the owner changes. The parameter points to a reference representing the original configuration state. This reference can be used to detect what configuration fields changed and so optimize any processing related to the change.
    The implemented logic must be idempotent - the method must produce the same results if executed once or multiple times not relying on any particular call sequence or related state. This is necessary so that the method can be repeated or retried as often as necessary without causing unintended effects
    
    Specified by:
    
    afterConfigUpdate in interface ConfigOwner<BrowseConfig>
    
    Parameters:
    
    beforeUpdate - Config reference capturing the config state before the owner's config was modified.
  - getCurrentRow
```
public int getCurrentRow()
```
    Get the current row.
    
    Returns:
    
    0-based index of the current row in the browse model. Negative numbers are returned for new rows. 0 is also returned if there are no rows.
  - getCurrentRowAsSelected
```
protected Browse.SelectedRow getCurrentRowAsSelected()
```
    Get the current row as Browse.SelectedRow object which takes into account its availability (see currentRowAvail).
    
    Returns:
    
    see above.
  - getCachedRowNumber
```
protected int getCachedRowNumber(BrowseRow[] rowCache,
                                 int rowIndex)
```
    Get the browse model index of the data row at the specified row index in the specified row cache.
    
    Parameters:
    
    rowCache - Cache of rows: dcData or intermediateDcData.
    
    rowIndex - 0-based index of the row in the given row cache.
    
    Returns:
    
    browse model index of the data row at the specified row index in the specified row cache or -1 if there is no row with the specified index.
  - getCachedRowNumber
```
public int getCachedRowNumber(int viewportIndex)
```
    Get the browse model index of the data row positioned at the specified viewport row.
    
    Parameters:
    
    viewportIndex - 0-based index of the target row in the viewport.
    
    Returns:
    
    0-based index of the target row in the browse model or -1 if there are no rows or there is no data row at the specified viewport row.
  - getCachedRowNumberWithIntermediate
```
public int getCachedRowNumberWithIntermediate(int viewportIndex)
```
    Get the browse model index of the data row in the row cache supplemented with "intermediate" rows (intermediateDcData), positioned at the specified viewport row.
    
    Parameters:
    
    viewportIndex - 0-based index of the target row in the viewport.
    
    Returns:
    
    0-based index of the target row in the browse model or -1 if there are no rows or there is no data row at the specified viewport row.
  - getCacheSize
```
public int getCacheSize()
```
    Get the number of rows in the cache (which matches the number of rows in the viewport).
    
    Returns:
    
    the number of rows in the cache.
  - getCacheSizeWithIntermediate
```
public int getCacheSizeWithIntermediate()
```
    Get the number of rows in the cache supplemented with "intermediate" rows (intermediateDcData), which matches the number of rows in the viewport.
    
    Returns:
    
    the number of rows in the cache supplemented with "intermediate" rows.
  - getViewportRow
```
public int getViewportRow()
```
    Get the index of the current row in the viewport.
    
    Returns:
    
    0-based index of the current row in the viewport.
  - getViewportRow
```
public int getViewportRow(int rowIndex)
```
    Get the index of the specified row in the viewport.
    
    Parameters:
    
    rowIndex - 0-based index of the target row in the browse model.
    
    Returns:
    
    0-based index of the specified row in the viewport. 0 if the row out of the current view.
  - calcDown
```
public int calcDown(int rowHeightPixels)
```
    Calculate DOWN value for the browse basing on the given row height.
    
    Parameters:
    
    rowHeightPixels - Row height in pixels.
    
    Returns:
    
    calculated DOWN value.
  - setIntermediateRows
```
public void setIntermediateRows(BrowseRow[] rows)
```
    Set "intermediate" rows (i.e. the rows that were already fetched in the process of getting new rows by BrowseWidget.getRows(int, int, boolean, int, ScreenBuffer[], RowDisplayStrategy)), so these rows can be drawn if a pause occurs in ROW-DISPLAY trigger.
    
    Parameters:
    
    rows - Rows to set.
  - incrementalScroll
```
protected boolean incrementalScroll(int rowCount)
```
    Scroll browse by the specified number of rows. If the number of rows is less than the page size, then some rows from the current view remain in the cache (without refresh). The new rows are obtained from the server starting from the first row which row index in the browse model is more than the index of the last row in the viewport (or less than the index of the first row if we scroll in backward direction).
    
    Parameters:
    
    rowCount - Number of rows to scroll. Positive count to scroll forward, negative to scroll backward.
    
    Returns:
    
    true if at least one row was obtained from the server.
  - incrementalScroll
```
protected boolean incrementalScroll(int rowCount,
                                    boolean forceTrailingSpace,
                                    boolean incrementalRowDisplay,
                                    boolean triggeredByScrollbar)
```
    Scroll browse by the specified number of rows. If the number of rows is less than the page size, then some rows from the current view remain in the cache (without refresh). The new rows are obtained from the server starting from the first row which row index in the browse model is more than the index of the last row in the viewport (or less than the index of the first row if we scroll in backward direction).
    
    Parameters:
    
    rowCount - Number of rows to scroll. Positive count to scroll forward, negative to scroll backward.
    
    forceTrailingSpace - If number rows returned by server is less than expected, then remaining rows will be spaces (i.e. (DOWN - rowCount) current rows in view are dropped unconditionally).
    
    incrementalRowDisplay - true if an incremental row display strategy is used.
    
    triggeredByScrollbar - true if the function is triggered by a scrollbar.
    
    Returns:
    
    true if at least one row was obtained from the server.
  - insertEditingRow
```
protected BrowseRow[] insertEditingRow(BrowseRow[] serverData,
                                       boolean forward,
                                       int maxSize,
                                       int lastRow,
                                       boolean allowBeforeFirst)
```
    If a new row is being edited, add this row into the given result set if it should be in this set.
    
    Parameters:
    
    serverData - Existing rows (order of rows is from top to bottom for any scrolling direction).
    
    forward - true for forward scrolling direction, false for backward.
    
    maxSize - Maximum allowed size of the resulting set.
    
    lastRow - For forward scrolling: last existing row before the rows from the result set. For backward scrolling: first existing row after the rows from the result set.
    
    allowBeforeFirst - If true, the edited row can take the first position in the result set (for its scrolling direction).
    
    Returns:
    
    resulting set with the currently edited new row included, if necessary.
  - initialize
```
public void initialize(WidgetId id,
                       BrowseConfig cfg)
```
    Replacement API for the logic which should exist in the widget's c'tor, but the logic can't be executed as it depends on the widget being registered into the official registry.
    This API is called after the widget is created and added to the registry.
    
    Specified by:
    
    initialize in interface WidgetWithConfig<BrowseConfig>
    
    Parameters:
    
    id - The widget's ID.
    
    cfg - The config used to initialize this widget.
  - destroy
```
public void destroy()
```
    Destroy this widget. Notify all of its components that the widget has been destroyed.
    
    Specified by:
    
    destroy in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    destroy in class AbstractContainer<O extends OutputManager<?>>
  - getDisplayFormat
```
public static DisplayFormat getDisplayFormat(BrowseColumnConfig colCfg)
```
    Get display format which corresponds to format string and data type stored in configuration.
    
    Returns:
    
    Instance of DisplayFormat.
  - getLabelVar
```
public static java.lang.String[] getLabelVar(BrowseColumnConfig colCfg)
```
    Return label as array of strings.
    
    Returns:
    
    Parsed label.
  - cellStartsWith
```
public static boolean cellStartsWith(java.lang.String cellText,
                                     char searchChar)
```
    Returns true if the visual representation of the cell content starts with the given character.
    
    Parameters:
    
    cellText - Cell text.
    
    searchChar - Target character.
    
    Returns:
    
    true if visual representation of the cell content starts with the given character.
  - setEnabled
```
public void setEnabled(boolean enabled)
```
    Description copied from class: AbstractWidget
    
    Enable/disable widget.
    
    Specified by:
    
    setEnabled in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    setEnabled in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    enabled - New enabled state.
    
    See Also:
    
    Widget.setEnabled(boolean)
  - setHighlighted
```
public void setHighlighted(boolean highlighted)
```
    Tracks the highlighted state of the component.
    
    Specified by:
    
    setHighlighted in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    setHighlighted in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    highlighted - New highlighted state.
  - initQueryAssigned
```
public void initQueryAssigned()
```
    Second stage of the initialization of the Browse widget which is performed only when query is initially assigned.
  - getValue
```
public BaseDataType getValue()
```
    Getting the BaseDataType object representing the current value.
    
    Returns:
    
    The value representing the current widget value.
  - onFocusGained
```
public void onFocusGained(FocusEvent event)
```
    Handle situation when Browse widget receives the focus.
    When a help string is defined for the browse it will be displayed on the status line. This method also sets the selected attribute on.
    
    Specified by:
    
    onFocusGained in interface FocusListener
    
    Parameters:
    
    event - Reference to the event.
  - onFocusLost
```
public void onFocusLost(FocusEvent fe_)
```
    Handle situation when Browse widget loses the focus.
    This method clears the focused flag.
    
    Specified by:
    
    onFocusLost in interface FocusListener
    
    Parameters:
    
    fe_ - Reference to the event.
  - undoValue
```
public void undoValue()
```
    Undo editing operation results and reset everything to initial state.
  - undoValue
```
public boolean undoValue(boolean startEdit)
```
    Undo editing operation results and reset everything to initial state.
    
    Parameters:
    
    startEdit - true to call startEdit() after the value has been undone.
    
    Returns:
    
    true if the edit was stopped.
  - valid
```
public boolean valid()
```
    Browse behaves like simple component in this regard.
    
    Returns:
    
    true.
  - requestFocus
```
public void requestFocus()
```
    Requesting the focus to the Browse.
    
    Specified by:
    
    requestFocus in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    requestFocus in class FixedSizeContainer<O extends OutputManager<?>>
  - requestFocus
```
public void requestFocus(boolean force,
                         boolean mouse)
```
    Request focus.
    
    Specified by:
    
    requestFocus in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    requestFocus in class FixedSizeContainer<O extends OutputManager<?>>
    
    Parameters:
    
    force - When true the method will set focus on this widget unconditionally.
    
    mouse - If true then the focus request was caused by a mouse event.
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
    Set READ-ONLY attribute.
    
    Parameters:
    
    readOnly - New value for the attribute.
  - selectAll
```
public void selectAll()
```
    Select all rows.
  - deselectAll
```
public void deselectAll()
```
    Remove all selections.
  - toggleSelectedRows
```
public void toggleSelectedRows(boolean select,
                               int start,
                               int end)
```
    For multi-selection browse, select or deselect the range of rows. To deselect all rows, set start and end to -1.
    
    Parameters:
    
    select - true to select the range of rows. false to deselect the range of rows.
    
    start - The first row in the range (inclusive).
    
    end - The last row in the range (inclusive).
  - selectFocusedRow
```
public void selectFocusedRow()
```
    Select row which is currently in focus.
  - selectRow
```
public boolean selectRow(int rowIndex)
```
    Implements the SELECT-ROW() widget method.
    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.
    
    Parameters:
    
    rowIndex - 0-based row index in the browse viewport.
    
    Returns:
    
    true if the row with the given index exist in the browse viewport.
  - deselectFocusedRow
```
public void deselectFocusedRow()
```
    Deselect row which is currently in focus.
  - getVisibleColumnCount
```
public int getVisibleColumnCount()
```
    Get the number of visible columns.
    
    Returns:
    
    number of visible columns.
  - getColumnCount
```
public int getColumnCount()
```
    Get the number of columns.
    
    Returns:
    
    number of columns.
  - deselectSelectedRow
```
public boolean deselectSelectedRow(int rowIndex)
```
    Implements the DESELECT-SELECTED-ROW() widget method.
    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.
    
    Parameters:
    
    rowIndex - 0-based index of the row (in the list of selected rows) to deselect.
    
    Returns:
    
    true if the row is successfully deselected.
  - getTextAlign
```
public static BrowseTextAlignment getTextAlign(BrowseColumn column)
```
    Get browse column text alignment.
    
    Parameters:
    
    column - Target browse column.
    
    Returns:
    
    browse column text alignment.
  - getTextAlign
```
public static BrowseTextAlignment getTextAlign(BrowseColumnConfig columnConfig)
```
    Get browse column text alignment.
    
    Parameters:
    
    columnConfig - Config of the target browse column.
    
    Returns:
    
    browse column text alignment.
  - getCellText
```
public static java.lang.String getCellText(BrowseColumnConfig columnConfig,
                                           BaseDataType var)
                                    throws DisplayFormatCheckException
```
    Get cell text to render.
    
    Parameters:
    
    columnConfig - Config of the browse column the cell belongs to.
    
    var - Cell data.
    
    Returns:
    
    Rendered cell text.
    
    Throws:
    
    DisplayFormatCheckException - Data is incompatible with format.
  - getCellTextNoError
```
public static java.lang.String getCellTextNoError(BrowseColumnConfig columnConfig,
                                                  BaseDataType var)
```
    Get cell text to render, without raising error.
    
    Parameters:
    
    columnConfig - Config of the browse column the cell belongs to.
    
    var - Cell data.
    
    Returns:
    
    Rendered cell text or question marks ("????...") if the value cannot be displayed using the current format.
  - generateQuestionMarks
```
protected static java.lang.String generateQuestionMarks(BrowseColumnConfig columnConfig,
                                                        BaseDataType var)
```
    Generate question marks that indicate that the cell value cannot be displayed using the current format.
    
    Parameters:
    
    columnConfig - Config of the browse column the cell belongs to.
    
    var - Cell data.
    
    Returns:
    
    string of question marks to be displayed in the cell.
  - config
```
public BrowseConfig config()
```
    Provide access to the attributes stored in the widget.
    
    Specified by:
    
    config in interface Widget<O extends OutputManager<?>>
    
    Specified by:
    
    config in interface ConfigOwner<BrowseConfig>
    
    Overrides:
    
    config in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    Reference to attribute container.
  - drawCaret
```
public abstract void drawCaret()
```
    Sets position of terminal's cursor. Redirects this positioning to the in-place editor if it is present. Otherwise does nothing because BROWSE itself has no purpose for the hardware cursor.
    
    Specified by:
    
    drawCaret in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    drawCaret in class AbstractWidget<O extends OutputManager<?>>
  - draw
```
public abstract void draw()
```
    Draws the widget: border, header, selection marks and line, internal FillIn etc.
    
    Specified by:
    
    draw in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    draw in class AbstractContainer<O extends OutputManager<?>>
  - focusTraversable
```
public boolean focusTraversable()
```
    This component will receive an input focus when Tab or Shift-Tab is pressed.
    
    Specified by:
    
    focusTraversable in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    focusTraversable in class AbstractContainer<O extends OutputManager<?>>
    
    Returns:
    
    true if this component is enabled and visible.
  - currentFocus
```
public Widget<O> currentFocus()
```
    Returns the same as getDefaultFocus() because focus placement inside BROWSE can't be switched from initial component until subcomponent creation or deletion.
    
    Specified by:
    
    currentFocus in interface Container<O extends OutputManager<?>>
    
    Overrides:
    
    currentFocus in class AbstractContainer<O extends OutputManager<?>>
    
    Returns:
    
    focused widget.
    
    See Also:
    
    Container.currentFocus()
  - defaultFocus
```
public Widget<O> defaultFocus()
```
    Returns this component directly if there is no in-place editor. Otherwise returns this editor.
    
    Specified by:
    
    defaultFocus in interface Container<O extends OutputManager<?>>
    
    Overrides:
    
    defaultFocus in class AbstractContainer<O extends OutputManager<?>>
    
    Returns:
    
    default focusable widget.
    
    See Also:
    
    Container.defaultFocus()
  - hasFocusable
```
public boolean hasFocusable(boolean next,
                            Widget<O> exclude)
```
    Reports if there is at least 1 focusable column that is not the current column.
    
    Parameters:
    
    next - true if this must search for a next focusable widget, false for a previous focusable widget.
    
    exclude - This is ignored since the current column is internally known by the browse.
    
    Returns:
    
    true if there is at least one other column that can be focused.
  - hasFocusable
```
public boolean hasFocusable(Widget<O> exclude)
```
    Reports if there is at least 1 focusable component that is not the given component.
    
    Specified by:
    
    hasFocusable in interface Container<O extends OutputManager<?>>
    
    Overrides:
    
    hasFocusable in class AbstractContainer<O extends OutputManager<?>>
    
    Parameters:
    
    exclude - A component to ignore or null if any focusable component will do.
    
    Returns:
    
    true if there is at least one other component that can be focused.
  - nextFocus
```
public void nextFocus()
```
    This method is called from the in-place editor when it need to initiate switching to the next widget.
    
    Specified by:
    
    nextFocus in interface Container<O extends OutputManager<?>>
    
    Overrides:
    
    nextFocus in class AbstractContainer<O extends OutputManager<?>>
    
    See Also:
    
    Container.nextFocus()
  - prevFocus
```
public void prevFocus()
```
    This method is called from the in-place editor when it need to initiate switching to the previous widget.
    
    Specified by:
    
    prevFocus in interface Container<O extends OutputManager<?>>
    
    Overrides:
    
    prevFocus in class AbstractContainer<O extends OutputManager<?>>
    
    See Also:
    
    Container.prevFocus()
  - isSelectionMultiple
```
public boolean isSelectionMultiple()
```
    Returns selection mode state.
    
    Returns:
    
    Is browse in the multiple selection mode.
  - setSelectionMultiple
```
public void setSelectionMultiple(boolean multiple)
```
    Switch multiple selection on and off.
    
    Parameters:
    
    multiple - true enable multiple selection, false - disable multiple selection.
  - isRowSelected
```
public boolean isRowSelected(int rowIndex)
```
    Returns is given row selected.
    
    Parameters:
    
    rowIndex - 0-based row's index in browse model.
    
    Returns:
    
    Is this row selected.
  - getFocusedRow
```
public integer getFocusedRow()
```
    Implements the FOCUSED-ROW attribute getter.
    
    Returns:
    
    1-based index of the focused row in the viewport. If there are no rows, 1 is returned,
  - getSelectedRowsCount
```
public int getSelectedRowsCount()
```
    Returns the count of selected rows.
    
    Returns:
    
    The count of selected rows.
  - getSelectedRowIndex
```
public int getSelectedRowIndex(int selIndex)
```
    Get the index (in the browse model) of the given selected row.
    
    Parameters:
    
    selIndex - 0-based position of the row in the list of selected rows. -1 for the last selected row.
    
    Returns:
    
    0-based index of the row in the browse model.
    
    Throws:
    
    ErrorConditionException - If selIndex is invalid or if there are no "available" rows.
  - checkDeleteEntryRowIndex
```
public void checkDeleteEntryRowIndex()
```
    Check that the current row can be deleted with DELETE-RESULT-LIST-ENTRY: the row should be existing and in the view.
    
    Throws:
    
    ErrorConditionException - If the current row is not existing or not in the view.
  - getSelectedRowIndex
```
public int getSelectedRowIndex(int selIndex,
                               boolean ignoreNotAvail,
                               boolean newAsAvail)
```
    Get the index (in the browse model) of the given selected row.
    
    Parameters:
    
    selIndex - 0-based position of the row in the list of selected rows. -1 for the last selected row.
    
    ignoreNotAvail - If true then exception is not raised if the selected row is not available.
    
    newAsAvail - Count new rows as "available". Affects error handling.
    
    Returns:
    
    0-based index of the row in the browse model.
    
    Throws:
    
    ErrorConditionException - If selIndex is invalid or if there are no "available" rows and ignoreNotAvail parameter is not specified.
  - getSelectedRowIndexes
```
public int[] getSelectedRowIndexes()
```
    Retrieve the row indexes of the selected rows in the given browse widget.
    
    Returns:
    
    Array of 0-based row indexes of the selected rows in the browse.
    
    Throws:
    
    ErrorConditionException - If selIndex is invalid or if there are no "available" rows.
  - getMaximalSelectedRowIndex
```
public int getMaximalSelectedRowIndex()
```
    Get the maximal row index (in the browse model) among the selected rows,
    
    Returns:
    
    maximal row index (in the browse model) among the selected rows or -1 if there are no selected rows.
  - fireDefaultAction
```
public void fireDefaultAction()
```
    Fires the DefaultAction event.
  - fireValueChanged
```
public void fireValueChanged()
```
    Fires the ValueChanged event.
  - startTrigger
```
public void startTrigger(int eventCode)
```
    Manages the internal state before the trigger is started.
    
    Specified by:
    
    startTrigger in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    eventCode - The event code
  - completeTrigger
```
public void completeTrigger(int eventCode)
```
    Manages the internal state after the trigger is finished.
    
    Specified by:
    
    completeTrigger in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    eventCode - The event code
  - acceptTrigger
```
public boolean acceptTrigger(int eventCode)
```
    Tests if the target event can be triggered or not.
    
    Specified by:
    
    acceptTrigger in interface Widget<O extends OutputManager<?>>
    
    Parameters:
    
    eventCode - The target events code
    
    Returns:
    
    True if the target event can be triggered, otherwise false.
  - isCurrentRowModified
```
public boolean isCurrentRowModified()
```
    Return status of the updates of the current row.
    
    Returns:
    
    true if current row is modified and false otherwise.
  - resetColUpdatesInCurrentRow
```
public void resetColUpdatesInCurrentRow(int col)
```
    Reset current row updates for a column.
    
    Parameters:
    
    col - a column ordinal.
  - refreshCurrentRow
```
public void refreshCurrentRow(BrowseRow row)
```
    Refresh the current browse row using the provided data.
    
    Parameters:
    
    row - Container with the new data for the current row. If an BrowseRow.data element is null, corresponding cell shouldn't be refreshed.
  - rowEntryCreated
```
public void rowEntryCreated(int newRowId)
```
    Performs client-side actions after a new row has been added to the backing result set using CREATE-RESULT-LIST-ENTRY. Updates row IDs in the current view.
    
    Parameters:
    
    newRowId - 0-based index of the newly created row in the browse model. Replaces the old negative row id of the current new row.
  - rowEntryDeleted
```
public void rowEntryDeleted(int deletedRowId)
```
    Performs client-side actions after a row has been deleted from the backing result set using DELETE-RESULT-LIST-ENTRY. Updates row IDs in the current view.
    
    Parameters:
    
    deletedRowId - 0-based index of the deleted row in the browse model.
  - isCurrentRowInView
```
public boolean isCurrentRowInView()
```
    Determine if the current row is in the view.
    
    Returns:
    
    true if the current row is the view.
  - isNewRow
```
public boolean isNewRow()
```
    Returns true if the current row is a new row and is not present in the database.
    
    Returns:
    
    true if the current row is a new row and false otherwise.
  - isNewRow
```
public boolean isNewRow(int newRowIndex)
```
    Returns true if the given row is a new row and is not present in the database.
    
    Parameters:
    
    newRowIndex - 0-based index of the target row in the browse model (new rows have specific negative indexes).
    
    Returns:
    
    true if the given row is a new row and false otherwise.
  - getBrowseColumnY
```
public abstract int getBrowseColumnY()
```
    Get value of column.Y attribute for the columns of this browse: vertical offset of the current row from the top of the browse, in pixels for GUI or in chars for ChUI. The value is the same for all columns in the browse.
    
    Returns:
    
    value of column.Y attribute for the columns of this browse.
  - insertRow
```
public boolean insertRow(boolean after)
                  throws ErrorConditionException
```
    Inserts a blank row in an updateable browse before or after the last selected row. The blank row is a placeholder for a new record to be added through the browse.
    
    Parameters:
    
    after - true if the row is added after the last selected row. false if the row is added before the last selected row.
    
    Returns:
    
    true if the row was successfully added.
    
    Throws:
    
    ErrorConditionException - In specific cases when row cannot be added. The exception contains proper 4GL error code.
  - insertRowSecondPart
```
public void insertRowSecondPart()
```
    Second part of insertRow(boolean) processing, which is usually executed after the trigger containing the INSERT-ROW call, finishes.
  - needsInsertRowContinueOnEntry
```
public boolean needsInsertRowContinueOnEntry(BrowseColumn entryColumn)
```
    Returns true if we need to perform the second stage of INSERT-ROW immediately, as a reaction to browse column "entry" event.
    
    Parameters:
    
    entryColumn - The column which received an "entry" event.
    
    Returns:
    
    see above.
  - isFocusedRowSelected
```
public boolean isFocusedRowSelected()
```
    Return true if row which has focus is selected.
    
    Returns:
    
    true if row which has focus is selected and false otherwise.
  - getDown
```
public int getDown()
```
    Return number of potential data rows in the Browse. Amount of available data can be less that number of rows which potentially can be displayed by the Browse.
    
    Returns:
    
    Number of potential rows.
  - getModel
```
public BrowseModel getModel()
```
    Get currently used BrowseModel.
    
    Returns:
    
    Reference to BrowseModel used by Browse.
  - getPrevColumn
```
public BrowseColumnConfig getPrevColumn(BrowseColumnConfig column)
```
    Return reference to previous column relative to given column.
    
    Parameters:
    
    column - Base column.
    
    Returns:
    
    Reference to next column relative to given.
  - getNextColumn
```
public BrowseColumnConfig getNextColumn(BrowseColumnConfig column)
```
    Return reference to next column relative to given column.
    
    Parameters:
    
    column - Base column.
    
    Returns:
    
    Reference to next column relative to given.
  - getIdsOfColumnWidgets
```
public int[] getIdsOfColumnWidgets()
```
    Get widget IDs of the browse column widgets.
    
    Returns:
    
    array of widget IDs of the browse column widgets.
  - isSelectedRowAvailable
```
public boolean isSelectedRowAvailable(int selIndex,
                                      boolean newAsAvailable)
```
    Determines if the specific selected row was available (could be fetched) at the moment of its selection.
    
    Parameters:
    
    selIndex - 0-based position of the row in the list of selected rows. If -1 is passed then all of the selected rows are checked for availability.
    
    newAsAvailable - Count new rows as "available".
    
    Returns:
    
    true if the specific selected row was available (could be fetched) at the moment of its selection. If -1 is passed then true is returned if at least one of the selected rows is available.
  - doLayout
```
public void doLayout()
```
    Lay out the browse.
    
    Specified by:
    
    doLayout in interface Container<O extends OutputManager<?>>
    
    Overrides:
    
    doLayout in class AbstractContainer<O extends OutputManager<?>>
  - getFocusedWidget
```
public Widget getFocusedWidget()
```
    Returns the widget which corresponds the FOCUS handle if this browse is focused.
    
    Returns:
    
    if editing is in process - the editor widget (fill-in by default), otherwise - this browse widget.
  - setEditorReadOnly
```
public void setEditorReadOnly(boolean readOnly)
```
    If browse is in editing mode, set editor in 4GL READ-ONLY mode.
    
    Parameters:
    
    readOnly - true to set editor in 4GL READ-ONLY mode.
  - getColumnCfg
```
public BrowseColumnConfig getColumnCfg(int columnOrdinal)
```
    Return BrowseColumnConfig for specified index.
    
    Parameters:
    
    columnOrdinal - 0-based index of the column among all columns (i.e. column ordinal).
    
    Returns:
    
    BrowseColumn instance or null in case of invalid index.
  - isEditorComboBox
```
public boolean isEditorComboBox()
```
    Returns true if the current editor is a combo-box.
    
    Returns:
    
    see above.
  - getVisibleColumnCfg
```
protected BrowseColumnConfig getVisibleColumnCfg(int visibleColumnIndex)
```
    Return BrowseColumnConfig for specified index.
    
    Parameters:
    
    visibleColumnIndex - 0-based index of the column among the visible columns.
    
    Returns:
    
    BrowseColumn instance or null in case of invalid index.
  - getActiveEditor
```
protected Widget getActiveEditor()
```
    Returns the active in-place editor if edit is in progress.
    
    Returns:
    
    Reference to editor or null.
  - isEditing
```
public boolean isEditing()
```
    Returns true if editing is in progress.
    
    Returns:
    
    true if editing is in progress.
  - getActiveFillIn
```
protected FillIn getActiveFillIn()
```
    Get active editor (assumes it is a fill-in). Before using this function, use isEditorFillIn() to check if the active editor is a fill-in, otherwise ClassCastException may be thrown.
    
    Returns:
    
    active fill-in editor.
    
    Throws:
    
    java.lang.ClassCastException - if the active editor is not a fill-in.
  - getActiveToggleBox
```
protected ToggleBox getActiveToggleBox()
```
    Get active editor (assumes it is a toggle-box). Before using this function, use isEditorToggleBox() to check if the active editor is a toggle-box, otherwise ClassCastException may be thrown.
    
    Returns:
    
    active toggle-box editor.
    
    Throws:
    
    java.lang.ClassCastException - if the active editor is not a toggle-box.
  - getActiveComboBox
```
protected ComboBox getActiveComboBox()
```
    Get active editor (assumes it is a combo-box). Before using this function, use isEditorComboBox() to check if the active editor is a combo-box, otherwise ClassCastException may be thrown.
    
    Returns:
    
    active combo-box editor.
    
    Throws:
    
    java.lang.ClassCastException - if the active editor is not a combo-box.
  - isEditorFillIn
```
protected boolean isEditorFillIn()
```
    Returns true if the current editor is a fill-in.
    
    Returns:
    
    see above.
  - isEditorToggleBox
```
protected boolean isEditorToggleBox()
```
    Returns true if the current editor is a toggle-box.
    
    Returns:
    
    see above.
  - getEditorValue
```
protected BaseDataType getEditorValue()
```
    Get value of the editor widget. See DataContainer.getValue().
    
    Returns:
    
    value of the editor widget.
  - isEditorModified
```
protected boolean isEditorModified()
```
    Returns true if the widget value was modified. See DataContainer.isModified().
    
    Returns:
    
    true if the widget value was modified.
  - setEditorValue
```
protected void setEditorValue(BaseDataType value)
```
    Set value of the editor widget. See DataContainer.setValue(BaseDataType).
    
    Parameters:
    
    value - value of the editor widget to set.
  - isNewEditingRowOutOfTheView
```
protected boolean isNewEditingRowOutOfTheView()
```
    Returns true if there is a new editing row which is out of the view.
    
    Returns:
    
    see above.
  - columnToView
```
protected abstract void columnToView(int visibleColumnIndex)
```
    Setups scrolling to fully (as possible) show the given column.
    
    Parameters:
    
    visibleColumnIndex - 0-based index of the column among the visible columns.
  - startEdit
```
public boolean startEdit()
```
    Creates an editor for the current cell and adds it to the browse. Adjusts selection data if necessary.
  - startEdit
```
public boolean startEdit(WidgetId prevFocus)
```
    Creates an editor for the current cell and adds it to the browse. Adjusts selection data if necessary.
    
    Parameters:
    
    prevFocus - The previous focused widget, which will lose focus.
    
    Returns:
    
    true if editing was on and ENTRY triggered allowed it to stop.
  - stopEdit
```
public boolean stopEdit(WidgetId nextFocus)
```
    Finishes edit and destroys an editor.
    
    Parameters:
    
    nextFocus - The widget which will be focused next.
    
    Returns:
    
    true if editing was stopped; false if we were not in edit mode or validation failed.
  - stopEdit
```
protected boolean stopEdit(boolean undo,
                           boolean validate)
```
    Finishes edit and destroys an editor.
    
    Parameters:
    
    undo - true if the value in the cell is undone rather than committed.
    
    validate - true to perform validation.
    
    Returns:
    
    true if editing was stopped; false if we were not in edit mode or validation failed.
  - stopEdit
```
protected boolean stopEdit(WidgetId nextFocus,
                           boolean undo,
                           boolean validate)
```
    Finishes edit and destroys an editor.
    
    Parameters:
    
    nextFocus - The widget which will be focused next.
    
    undo - true if the value in the cell is undone rather than committed.
    
    validate - true to perform validation.
    
    Returns:
    
    true if editing was stopped; false if we were not in edit mode or validation failed.
  - stopEdit
```
protected boolean stopEdit(WidgetId nextFocus,
                           boolean undo,
                           boolean validate,
                           boolean skipCellLeave)
```
    Finishes edit and destroys an editor.
    
    Parameters:
    
    nextFocus - The widget which will be focused next.
    
    undo - true if the value in the cell is undone rather than committed.
    
    validate - true to perform validation.
    
    skipCellLeave - true to skip invocation of cell LEAVE trigger even if the cell value is committed.
    
    Returns:
    
    true if editing was stopped; false if we were not in edit mode or validation failed.
  - validateStopEdit
```
private boolean validateStopEdit(boolean undo,
                                 boolean validate)
```
    Validates current editor.
    
    Parameters:
    
    undo - true if the value in the cell is undone rather than committed.
    
    validate - true to perform validation.
    
    Returns:
    
    true if validation passed or we were not in edit mode.
  - checkChuiRowInView
```
protected boolean checkChuiRowInView()
```
    For ChUI: if the current row is not in the view, set the top row in the view as the current row.
    
    Returns:
    
    true if the the top row in the view has been set as the current row.
  - finishStopEdit
```
public void finishStopEdit()
```
    Stops the current editor.
  - isInColumnEntryTrigger
```
public boolean isInColumnEntryTrigger()
```
    Returns true if an column ENTRY trigger is running.
    
    Returns:
    
    true if an column ENTRY trigger is running.
  - isInsertingRow
```
public boolean isInsertingRow()
```
    Returns the current stage of insert-row operation.
    
    Returns:
    
    True if the insert-row operation has not been completed yet, otherwise false.
  - setKeepEditingColumn
```
public void setKeepEditingColumn()
```
    If INSERT-ROW is happening, keep the current editing column when the new row is added rather than reset it to the first editable column.
  - getEditorConfig
```
protected WidgetConfig getEditorConfig(int columnOrdinal)
```
    Get configuration of the editor (fill-in, toggle-box or combo-box) used for in-browse editing for the target column.
    
    Parameters:
    
    columnOrdinal - 0-based ordinal of the target column.
    
    Returns:
    
    configuration of the editor for the target column or null if the column is not editable.
  - validateEditorValue
```
protected boolean validateEditorValue()
```
    Run validation for the current editor.
    
    Returns:
    
    true if no validation for the current column or validation was successful.
  - initEditorConfig
```
protected abstract void initEditorConfig(BaseConfig cfg)
```
    Initialize editor widget config.
    
    Parameters:
    
    cfg - Editor widget config.
  - addEditor
```
protected abstract void addEditor(Widget editor)
```
    Add editor widget to the browse.
    
    Parameters:
    
    editor - Editor widget.
  - cleanupEditor
```
protected void cleanupEditor(Widget editor)
```
    Clean up editor widget.
    
    Parameters:
    
    editor - Editor widget.
  - addNewRow
```
protected int addNewRow(int rowIndex,
                        BaseDataType[] rowData,
                        int viewportRow,
                        boolean after)
```
    Add new row to the cache.
    
    Parameters:
    
    rowIndex - 0-based index of the row in the browse model or -1 if an empty row is generated.
    
    rowData - Row cache data. null to generate an empty row.
    
    viewportRow - 0-based index of the base row in the viewport.
    
    after - true if the row will be inserted after the base row. false if before the base row.
    
    Returns:
    
    0-based index of the new row in the viewport
  - startEdit
```
protected boolean startEdit(boolean updateSelection)
```
    Creates an editor for the current cell and adds it to the browse. Adjusts selection data if necessary.
    
    Parameters:
    
    updateSelection - For multi-selection browse: if true, current row becomes the only selected row.
    
    Returns:
    
    true if editing was on and ENTRY triggered allowed it to stop.
  - startEdit
```
protected boolean startEdit(boolean updateSelection,
                            boolean sendEntry)
```
    Creates an editor for the current cell and adds it to the browse. Adjusts selection data if necessary. Controls the row-entry event is emitted or not.
    
    Parameters:
    
    updateSelection - For multi-selection browse: if true, current row becomes the only selected row.
    
    sendEntry - Its true value permits to emit the row-entry event.
    
    Returns:
    
    true if editing was on and ENTRY triggered allowed it to stop.
  - startEdit
```
protected boolean startEdit(WidgetId prevFocus,
                            boolean updateSelection,
                            boolean useValue,
                            BaseDataType value)
```
    Creates an editor for the current cell and adds it to the browse. Adjusts selection data if necessary.
    
    Parameters:
    
    prevFocus - The previous focused widget, which will lose focus.
    
    updateSelection - For multi-selection browse: if true, current row becomes the only selected row.
    
    useValue - Use the specified value for the editor instead of getting it from the browse cache.
    
    value - Value to use in the editor. Can be null (valid value). Set useValue to true if you want to use this parameter.
    
    Returns:
    
    true if editing was on and ENTRY triggered allowed it to stop.
  - startEdit
```
protected boolean startEdit(WidgetId prevFocus,
                            boolean updateSelection,
                            boolean useValue,
                            BaseDataType value,
                            boolean sendEntry)
```
    Creates an editor for the current cell and adds it to the browse. Adjusts selection data if necessary. Controls the row-entry event is emitted or not.
    
    Parameters:
    
    prevFocus - The previous focused widget, which will lose focus.
    
    updateSelection - For multi-selection browse: if true, current row becomes the only selected row.
    
    useValue - Use the specified value for the editor instead of getting it from the browse cache.
    
    value - Value to use in the editor. Can be null (valid value). Set useValue to true if you want to use this parameter.
    
    sendEntry - Its true value permits to emit the row-entry event.
    
    Returns:
    
    true if editing was on and ENTRY triggered allowed it to stop.
  - createEditor
```
protected Widget createEditor(boolean useValue,
                              BaseDataType value)
```
    Create editor fill-in for the current column.
    
    Parameters:
    
    useValue - Use the specified value for the editor instead of getting it from the browse cache.
    
    value - Value to use in the editor. Can be null (valid value). Set useValue to true if you want to use this parameter.
    
    Returns:
    
    editor fill-in for the current column.
  - createEditingFillIn
```
protected FillIn createEditingFillIn(boolean useValue,
                                     BaseDataType value)
```
    Create fill-in editor widget for the current column.
    
    Parameters:
    
    useValue - Use the specified value for the editor instead of getting it from the browse cache.
    
    value - Value to use in the editor. Can be null (valid value). Set useValue to true if you want to use this parameter.
    
    Returns:
    
    fill-in editor widget for the current column.
  - displayErrorMessage
```
protected void displayErrorMessage(java.lang.String message)
```
    Display browse-related error message.
    
    Parameters:
    
    message - Message to display.
  - updateColumn
```
protected boolean updateColumn(int columnOrdinal,
                               BaseDataType var)
```
    Update specified cell in current row.
    
    Parameters:
    
    columnOrdinal - 0-based index of the cell to update.
    
    var - New value of the cell.
    
    Returns:
    
    true if column value was changed.
  - switchToPrevCell
```
void switchToPrevCell()
```
    Switches in-line editor to the previous editable cell. Initiates commit of the current row if necessary.
  - switchToNextCell
```
protected void switchToNextCell()
```
    Switches in-line editor to the next editable cell. Initiates commit of the current row if necessary.
  - isFirstLastRowCopyQuirk
```
protected boolean isFirstLastRowCopyQuirk()
```
    Determine if this browse should have the following quirk: is a new row is inserted before the first row or after the last row, the value of the current column is copied from the first/last row to the new row.
    
    Returns:
    
    false
  - setColumnEditMode
```
private void setColumnEditMode(boolean mode)
```
    Changes the flag indicating the browse column is in editing mode. Used to inform server side about editing mode for current column.
    
    Parameters:
    
    mode - TRUE when editing mode is ON, FALSE otherwise.
  - saveCurrentRow
```
private boolean saveCurrentRow(boolean updateModel)
```
    Saves the current row into cache and data model.
    
    Parameters:
    
    updateModel - true if data model is updated. Otherwise only cache is updated.
    
    Returns:
    
    Is data checking and saving was successful.
  - notifyRowReleased
```
private void notifyRowReleased()
```
    Notify server that the row has been released. You do not need to call this function if you have any data to save.
  - resetModifiedFlags
```
private void resetModifiedFlags()
```
    Reset the modified flags. This is done for editable columns by changing the modifying flag of the editors. For read-only columns (which can have their screen value change by the legacy code), the modified flag is set at column config level.
  - releaseCurrentRow
```
protected Browse.RowLeaveResult releaseCurrentRow()
```
    Finishes editing and commits row to model if some updates are available. Restores editor if commit has failed.
    
    Returns:
    
    row leave result.
  - releaseCurrentRow
```
private Browse.RowLeaveResult releaseCurrentRow(boolean updateModel,
                                                boolean triggerRowLeave,
                                                boolean startFromSave)
```
    Finishes editing and commits row to model if some updates are available. Restores editor if commit has failed.
    
    Parameters:
    
    updateModel - true if data model is updated. Otherwise only cache is updated and validation does NOT take place.
    
    triggerRowLeave - true to trigger ROW-LEAVE event.
    
    startFromSave - true if row leaving procedure execution should start from row save step, i.e. row save, reposition to new row and start edit is executed, while stop edit and ROW-LEAVE trigger invocation is omitted.
    
    Returns:
    
    row leave result.
  - releaseCurrentRow
```
private Browse.RowLeaveResult releaseCurrentRow(boolean updateModel,
                                                boolean triggerRowLeave,
                                                boolean startFromSave,
                                                WidgetId nextId)
```
    Finishes editing and commits row to model if some updates are available. Restores editor if commit has failed.
    
    Parameters:
    
    updateModel - true if data model is updated. Otherwise only cache is updated and validation does NOT take place.
    
    triggerRowLeave - true to trigger ROW-LEAVE event.
    
    startFromSave - true if row leaving procedure execution should start from row save step, i.e. row save, reposition to new row and start edit is executed, while stop edit and ROW-LEAVE trigger invocation is omitted.
    
    nextId - ID of the next focusable widget.
    
    Returns:
    
    row leave result.
  - dcGetRowData
```
protected BaseDataType[] dcGetRowData(int rowIndex)
```
    Returns the row data with the given index. The row must already be in the cache.
    
    Parameters:
    
    rowIndex - Row's index in model.
    
    Returns:
    
    The row data from the cache.
  - dcGetRow
```
protected BrowseRow dcGetRow(int rowIndex)
```
    Returns the cached row with the given index. The row must already be in the cache.
    
    Parameters:
    
    rowIndex - Row's index in model.
    
    Returns:
    
    The row from the cache.
  - hasRowMarkers
```
public boolean hasRowMarkers()
```
    If the browse has row markers drawn. Note that the returned value may differ from BrowseWidget.hasRowMarkers().
    
    Returns:
    
    true if the browse has row markers drawn.
  - dcUpdateRow
```
private void dcUpdateRow(int rowIndex,
                         int[] cellIndices,
                         BaseDataType[] cellValues,
                         boolean updateModel,
                         boolean rowInView,
                         BrowseRow editedRowData)
                  throws DataValidationException
```
    Updates row in the cache and the model. Row must already be in cache.
    
    Parameters:
    
    rowIndex - 0-based row's index in model.
    
    cellIndices - Indexes of cells to update.
    
    cellValues - New values of cells to update.
    
    updateModel - true if data model is updated. Otherwise only cache is updated.
    
    rowInView - true if the edited row is in view.
    
    editedRowData - Data of the edited row before editing has started.
    
    Throws:
    
    DataValidationException - New values don't passed database validation rules.
  - onKeyPressed
```
public void onKeyPressed(KeyInput event)
```
    Process key event.
    
    Specified by:
    
    onKeyPressed in interface KeyListener
    
    Parameters:
    
    event - Reference to keyboard event.
  - processEvent
```
public void processEvent(Event evt)
```
    Intercept special events. Using regular keyTyped/keyPressed may not work if component is not in focus.
    
    Specified by:
    
    processEvent in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    processEvent in class AbstractWidget<O extends OutputManager<?>>
    
    Parameters:
    
    evt - Event to process.
    
    See Also:
    
    Widget.processEvent(com.goldencode.p2j.ui.client.event.Event)
  - onKeyTyped
```
public void onKeyTyped(KeyInput event)
```
    Handles ' ' key in R/O mode: fires ValueChanged event. Additionally inverts selection status of the current line in multiple selection mode.
    
    Specified by:
    
    onKeyTyped in interface KeyListener
    
    Parameters:
    
    event - Event which triggered this call.
    
    See Also:
    
    KeyListener.onKeyTyped(KeyInput)
  - notifyKeyPressedInEditor
```
public void notifyKeyPressedInEditor(KeyInput key)
```
    Notify the browse that the key was pressed when the editor is in focus.
    
    Parameters:
    
    key - The key which was pressed in the editor.
  - switchCurrentRowSelection
```
protected void switchCurrentRowSelection()
```
    For browse with multiple selection: select current row if it is not selected or deselect if it is selected.
  - getPageSize
```
protected int getPageSize()
```
    Get page size used for Page Up / Page Down.
    
    Returns:
    
    increment size (in rows) used for Page Up / Page Down.
  - setCurrentRow
```
protected void setCurrentRow(int currRow)
```
    Set the current row.
    
    Parameters:
    
    currRow - New current row (0-based index in the browse model).
  - setCurrentRow
```
private void setCurrentRow(int currRow,
                           boolean allowDeletedRow)
```
    Set the current row.
    
    Parameters:
    
    currRow - New current row (0-based index in the browse model).
    
    allowDeletedRow - If true, then currRow becomes the current row even if it doesn't exist in the result set anymore. If false then the next available row becomes the current row if the currRow doesn't exist.
  - setCurrentRow
```
protected void setCurrentRow(int currRow,
                             boolean updateSelection,
                             boolean allowDeletedRow)
```
    Set the current row.
    
    Parameters:
    
    currRow - New current row (0-based index in the browse model).
    
    updateSelection - true if selection should be adjusted.
    
    allowDeletedRow - If true, then currRow becomes the current row even if it doesn't exist in the result set anymore. If false then the next available row becomes the current row if the currRow doesn't exist.
  - refreshColumnsAttributes
```
protected void refreshColumnsAttributes()
```
    Refresh column attributes which are cell-specific (like @BGCOLOR@ or @FGCOLOR@) for all columns, with the cell data from the rows cache.
  - isAggressiveCurrentRowSelection
```
protected boolean isAggressiveCurrentRowSelection()
```
    Returns true if the current row of the single-selection browse is selected on FOCUS-GAINED and some other events.
    
    Returns:
    
    see above.
  - handleTabKey
```
protected void handleTabKey()
```
    Handle TAB key press.
  - getRepositionedRow
```
public int getRepositionedRow()
```
    Get repositioned row. I.e. the index of the viewport row where records positioned with the REPOSITION statement are displayed.
    
    Returns:
    
    0-based repositioned row.
  - isConditionalReposition
```
public boolean isConditionalReposition()
```
    Returns reposition mode set be SET-REPOSITIONED-ROW.
    
    Returns:
    
    true if reposition mode is "CONDITIONAL", false if reposition mode is "ALWAYS".
  - getCurrentColumn
```
public BrowseColumnConfig getCurrentColumn()
```
    Get the currently editing column.
    
    Returns:
    
    The currColumn value or null if not editing..
  - setCurrentColumn
```
public void setCurrentColumn(int columnOrdinal)
```
    Set the currently editing column.
    
    Parameters:
    
    columnOrdinal - Column ordinal in the browse definition (0-based). Count includes invisible columns too.
  - setCurrentColumnId
```
public void setCurrentColumnId(BrowseColumn column)
```
    Set BrowseConfig.currentColumnID, which effectively updates CURRENT-COLUMN on the server side.
    
    Parameters:
    
    column - New current column.
  - getColumnText
```
public java.lang.String getColumnText(int columnOrdinal)
```
    Get text value of the given column in current row.
    
    Parameters:
    
    columnOrdinal - 0-based index of the column among all columns.
    
    Returns:
    
    The text value of the given column in current row.
  - removeFromSelection
```
public void removeFromSelection(int deletedRowIndex)
```
    Remove given row(s) from the set of selected rows.
    
    Parameters:
    
    deletedRowIndex - 0-based index of the deleted row in the browse model. -1 if all selected rows are deleted.
  - getRowDeletionShift
```
private int getRowDeletionShift(int baseRow)
```
    Get the number of non-new selected rows before the given base row.
    
    Parameters:
    
    baseRow - 0-based index of the base row in the browse model.
    
    Returns:
    
    see above.
  - getValue
```
protected BaseDataType getValue(int columnOrdinal)
```
    Get value for the specified column.
    
    Parameters:
    
    columnOrdinal - 0-based column ordinal.
    
    Returns:
    
    Column value.
  - getValue
```
protected BaseDataType getValue(int columnOrdinal,
                                boolean useSelection)
```
    Get value for the specified column.
    
    Parameters:
    
    columnOrdinal - 0-based column ordinal.
    
    useSelection - true to get the value from the last selected row, where applicable. false to get the value from the current row.
    
    Returns:
    
    Column value.
  - getColumnValue
```
public BaseDataType getColumnValue(int columnOrdinal)
```
    Get value of the given column in current row.
    
    Parameters:
    
    columnOrdinal - 0-based index of the column among the columns.
    
    Returns:
    
    The value of the given column in current row.
  - setColumnValue
```
public void setColumnValue(int columnOrdinal,
                           BaseDataType value,
                           java.lang.String fmt)
```
    Set value for the given column in current row.
    
    Parameters:
    
    columnOrdinal - 0-based index of the column among all columns.
    
    value - The value for the cell.
    
    fmt - The format under which the value should be formatted.
  - isModified
```
public boolean isModified(int columnOrdinal)
```
    Check if the value in specified column in current row is changed.
    
    Parameters:
    
    columnOrdinal - 0-based index of the column.
    
    Returns:
    
    true if value is changed.
  - refresh
```
public void refresh(boolean deleteCurrentRowMode)
```
    Refresh the browse cache and redisplay the browse.
    
    Parameters:
    
    deleteCurrentRowMode - true if this function is used for update on DELETE-CURRENT-ROW. false if this function is used for update on REFRESH.
  - show
```
public void show()
```
    Show widget.
    
    Specified by:
    
    show in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    show in class AbstractWidget<O extends OutputManager<?>>
  - executePendingRefresh
```
public void executePendingRefresh(boolean queryReopened,
                                  boolean repositionBeforeReopen,
                                  int repositionedRow)
```
    Execute pending refresh when REFRESHABLE is turned on. Includes pending query repositions and reopenings.
    
    Parameters:
    
    queryReopened - true if there is a pending query reopening.
    
    repositionBeforeReopen - true if the last pending reposition was before the last pending reopening.
    
    repositionedRow - 0-based index of the last row the query was repositioned to. -1 if there is no repositioned row.
  - refreshScrollRow
```
public void refreshScrollRow(boolean leaveOnRowInView,
                             boolean preserveViewportRow)
```
    Refresh scroll row in the browse and redisplay. Unless specific parameters are passed, the current row becomes the scroll row.
    
    Parameters:
    
    leaveOnRowInView - If the current row is in the viewport, do not update the scroll row.
    
    preserveViewportRow - Try to preserve the current viewport row (i.e. the row at the same position in the viewport becomes the current row after refresh).
  - refreshScrollRow
```
public void refreshScrollRow(int scrollRow,
                             boolean leaveOnRowInView,
                             boolean preserveViewportRow)
```
    Refresh scroll row in the browse and redisplay. Unless specific parameters are passed, the current row becomes the scroll row.
    
    Parameters:
    
    scrollRow - New scroll row.
    
    leaveOnRowInView - If the current row is in the viewport, do not update the scroll row.
    
    preserveViewportRow - Try to preserve the current viewport row (i.e. the row at the same position in the viewport becomes the current row after refresh).
  - refreshScrollRow
```
public void refreshScrollRow(boolean leaveOnRowInView,
                             boolean preserveViewportRow,
                             boolean repositioned,
                             boolean repositionError,
                             int targetRepositionRow,
                             boolean leaveOnOnePageMode)
```
    Refresh scroll row in the browse and redisplay. Unless specific parameters are passed, the current row becomes the scroll row.
    
    Parameters:
    
    leaveOnRowInView - If the current row is in the viewport, do not update the scroll row.
    
    preserveViewportRow - Try to preserve the current viewport row (i.e. the row at the same position in the viewport becomes the current row after refresh).
    
    repositioned - If the browse is refreshed because the query was repositioned.
    
    repositionError - For reposition mode - if an error has happened during reposition.
    
    targetRepositionRow - For reposition mode - row used as the target for reposition. If it was deleted, reposition with fetching may end up on a different row.
    
    leaveOnOnePageMode - If the number of rows in the browse is less or equal DOWN, do not re-fetch rows.
  - refreshScrollRow
```
public void refreshScrollRow(int scrollRow,
                             boolean leaveOnRowInView,
                             boolean preserveViewportRow,
                             boolean repositioned,
                             boolean repositionError)
```
    Refresh scroll row in the browse and redisplay. Unless specific parameters are passed, the current row becomes the scroll row.
    
    Parameters:
    
    scrollRow - New scroll row.
    
    leaveOnRowInView - If the current row is in the viewport, do not update the scroll row.
    
    preserveViewportRow - Try to preserve the current viewport row (i.e. the row at the same position in the viewport becomes the current row after refresh).
    
    repositioned - If the browse is refreshed because the query was repositioned.
    
    repositionError - For reposition mode - if an error has happened during reposition.
  - refreshScrollRow
```
public void refreshScrollRow(int scrollRow,
                             boolean leaveOnRowInView,
                             boolean preserveViewportRow,
                             boolean repositioned,
                             boolean repositionError,
                             int targetRepositionRow,
                             boolean leaveOnOnePageMode)
```
    Refresh scroll row in the browse and redisplay. Unless specific parameters are passed, the current row becomes the scroll row.
    
    Parameters:
    
    scrollRow - New scroll row.
    
    leaveOnRowInView - If the current row is in the viewport, do not update the scroll row.
    
    preserveViewportRow - Try to preserve the current viewport row (i.e. the row at the same position in the viewport becomes the current row after refresh).
    
    repositioned - If the browse is refreshed because the query was repositioned.
    
    repositionError - For reposition mode - if an error has happened during reposition.
    
    targetRepositionRow - For reposition mode - row used as the target for reposition. If it was deleted, reposition with fetching may end up on a different row.
    
    leaveOnOnePageMode - If the number of rows in the browse is less or equal DOWN, do not re-fetch rows.
  - refreshAfterDeletion
```
public void refreshAfterDeletion(int rowIndex)
```
    Refresh the browse after some of its rows were deleted.
    
    Parameters:
    
    rowIndex - 0-based index of the deleted row in the browse model. -1 if all of the selected rows were deleted.
  - getEditorCursorOffset
```
protected int getEditorCursorOffset()
```
    Return the cursor offset from the left bound of the current in-cell editor.
    
    Returns:
    
    0-based offset, or -1 if there's no active editor, or the editor is not of a type which has a cursor.
  - setEditorCursorOffset
```
protected void setEditorCursorOffset(int cursorOffset)
```
    Set the cursor offset for the current in-cell editor, if there's an active editor and it is of a type which has a cursor.
    
    Parameters:
    
    cursorOffset - 0-based cursor offset from the left bound of the editor.
  - getRows
```
protected BrowseRow[] getRows(int startRowIndex,
                              int count,
                              boolean forward,
                              RowDisplayStrategy displayStrategy)
```
    Retrieves several subsequent rows from the database.
    
    Parameters:
    
    startRowIndex - Index of the first row to retrieve (0-based).
    
    count - Maximum count of rows to return. -1 for no limit.
    
    forward - true if rows are retrieved in the forward direction, false if rows are retrieved in the backward direction.
    
    displayStrategy - Specifies type of action for which rows are fetched and defines how rows are iterated / displayed.
    
    Returns:
    
    Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. Note that if rows are fetched in the backward direction, the resulting rows are returned in the straight order starting from the row with the least row number. If no query is specified or the query is closed, null is returned.
  - getRows
```
protected BrowseRow[] getRows(char searchChar,
                              int searchColumn,
                              int viewportTopRow,
                              int viewportBottomRow)
```
    This function is used when search by key is performed in a browse. Retrieves the set of rows which should be in view after search is completed. There are complex rules which determine the top row of the view depending on how the current row is positioned relatively to the current view and how the found row is positioned relatively to the current view and to the current row.
    
    Parameters:
    
    searchChar - Character to be searched for. Search is performed using only the first character (in the visual data representation) in the current column. Specifying a character puts this function in the search mode. This parameter is null for non-search mode.
    
    searchColumn - For search mode: 0-based index of the column to be searched.
    
    viewportTopRow - For search mode: 0-based index (in the result set) of the top row in the current view.
    
    viewportBottomRow - For search mode: 0-based index (in the result set) of the bottom row in the current view.
    
    Returns:
    
    Array of rows. Each row is array of cell values, but the first element of the row array is 0-based index of the row in the browse model. If no query is specified or the query is closed, null is returned.
  - getRowDisplayTriggerId
```
protected int getRowDisplayTriggerId()
```
    Get ID of the ROW-DISPLAY trigger for this browse.
    
    Returns:
    
    ID of the ROW-DISPLAY trigger for this browse or -1 if there is no such trigger.
  - getScreenBufferForTrigger
```
protected ScreenBuffer[] getScreenBufferForTrigger(int triggerId)
```
    Get screen buffer that can be used for trigger invocation on server side.
    
    Parameters:
    
    triggerId - ID of the trigger.
    
    Returns:
    
    screen buffer that can be used for trigger invocation on server side or null if no valid trigger ID is specified.
  - conditionalPendingExtraRowFetch
```
protected void conditionalPendingExtraRowFetch()
```
    If the top row in the view is the first row in the result set, set the pendingExtraRowFetch flag, which makes browse fetch an extra row on the next scroll in order to determine if one- or multi-page scrolling mode should take place.
  - queryClosed
```
public void queryClosed()
```
    Reset the cache and redisplay.
  - queryRepositioned
```
public void queryRepositioned(boolean repositionError,
                              int targetRepositionRow)
```
    Notify the browse that the underlying query has been repositioned.
    
    Parameters:
    
    repositionError - For reposition mode - if an error has happened during reposition.
    
    targetRepositionRow - For reposition mode - row used as the target for reposition. If it was deleted, reposition with fetching may end up on a different row.
  - selectNextRow
```
public boolean selectNextRow()
```
    Implements the SELECT-NEXT-ROW() widget method.
    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.
    
    Returns:
    
    true on success.
  - selectPreviousRow
```
public boolean selectPreviousRow()
```
    Implements the SELECT-PREV-ROW() widget method.
    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.
    
    Returns:
    
    true on success.
  - moveColumn
```
public void moveColumn(int srcIndex,
                       int destIndex)
```
    Implements the client side of the MOVE-COLUMN() widget method.
    Repositions a column in a browse widget.
    
    Parameters:
    
    srcIndex - 0-based position of the column to be moved (column ordinal).
    
    destIndex - 0-based position to which the column is moved (column ordinal).
  - applyEnhancedConfigClient
```
public void applyEnhancedConfigClient()
```
    Run client-side part of the code which should be executed after an enhanced configuration is applied to the browse.
  - isSavingRow
```
public boolean isSavingRow()
```
    Returns true if we are in the process of saving of the edited row.
    
    Returns:
    
    true if we are in the process of saving of the edited row.
  - clearWidget
```
public boolean clearWidget()
```
    Clear widget state on CLEAR FRAME call for the parent frame.
    
    Specified by:
    
    clearWidget in interface Widget<O extends OutputManager<?>>
    
    Overrides:
    
    clearWidget in class AbstractWidget<O extends OutputManager<?>>
    
    Returns:
    
    true.
  - scrollToCurrentRow
```
public void scrollToCurrentRow()
```
    Scrolls a browse (if necessary) to bring the currently selected row into view. If the browse supports multiple selections, then SCROLL-TO-CURRENT-ROW() brings the most recently selected row into view.
    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.
    
    Throws:
    
    ErrorConditionException - if a numbered error occurs.
  - scrollToSelectedRow
```
public void scrollToSelectedRow(int selectedRowIndex)
```
    Scrolls a browse (if necessary) to bring the specified selected row into view.
    
    Parameters:
    
    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.
    
    Throws:
    
    ErrorConditionException - if a numbered error occurs.
  - getNewRowsBefore
```
protected int getNewRowsBefore(int baseViewportRow)
```
    Get the number of new rows in the viewport before the given base viewport row.
    
    Parameters:
    
    baseViewportRow - 0-based index of the base row in the viewport.
    
    Returns:
    
    see above.
  - advanceRowSelection
```
protected boolean advanceRowSelection(boolean forward)
```
    Worker for selectNextRow() and selectPreviousRow().
    
    Parameters:
    
    forward - If true then it corresponds selectNextRow(). If false - selectPreviousRow().
    
    Returns:
    
    true on success.
  - isViewportEdge
```
protected boolean isViewportEdge(int rowIndex,
                                 boolean forward)
```
    Determines if the specified row is the first or last row in the view.
    
    Parameters:
    
    rowIndex - 0-based row index in the browse model.
    
    forward - true to check if it is the last row, false to check if it is the first row.
    
    Returns:
    
    true if the specified row is the first (if forward is true) or last (if forward is false) row in the view. If the page is not full then the last row on the page is NOT considered to be the last row in the view.
  - advanceCurrRowOrSelection
```
protected boolean advanceCurrRowOrSelection(boolean advanceSelection,
                                            boolean forward,
                                            boolean handleEditing,
                                            int rowIndex)
```
    Works in two modes:
    - Advance current row - make the row before or after the current row the new current row.
    - Advance selection - deselected all rows and make the row before or after the specified row selected.
    Parameters:
    
    advanceSelection - true for selection mode. false for current row mode.
    
    forward - true to advance to the next row. false to advance to the previous row.
    
    handleEditing - true to handle start/stop editing. For current row mode only.
    
    rowIndex - 0-based index of the row which should be used as a base for selection advancing (i.e. the row before or after it will be selected). For selection mode only.
    
    Returns:
    
    true if current/selected row has changed.
  - getLastAvailableSelectedRow
```
protected int getLastAvailableSelectedRow(boolean includeNewRows)
```
    Get last (in the order of selection) "available" (not deleted on the moment of selection) selected row.
    
    Parameters:
    
    includeNewRows - Include new rows in the search (consider them "available").
    
    Returns:
    
    0-based index of the selected row in the browse model or -1 if there are no "available" selected rows.
  - isRowInView
```
public boolean isRowInView(int rowIndex)
```
    Determines if the specified row is in the viewport.
    
    Parameters:
    
    rowIndex - Index of the target row in the browse model.
    
    Returns:
    
    true if the specified row is in the viewport.
  - goUp
```
protected boolean goUp(boolean handleEditing)
```
    Scroll one row up and adjust current row.
    
    Parameters:
    
    handleEditing - If true then do startEdit()/stopEdit(com.goldencode.p2j.ui.WidgetId) calls.
    
    Returns:
    
    true if the current row has changed.
  - goUp
```
protected boolean goUp(boolean handleEditing,
                       boolean fireValueChanged,
                       boolean startFromSave)
```
    Scroll one row up and adjust current row.
    
    Parameters:
    
    handleEditing - If true then do startEdit()/stopEdit(com.goldencode.p2j.ui.WidgetId) calls.
    
    fireValueChanged - If true then VALUE-CHANGED event is fired if current row has changed.
    
    startFromSave - true if row leaving procedure execution should start from row save step, i.e. row save, reposition to new row and start edit is executed, while stop edit and ROW-LEAVE trigger invocation is omitted.
    
    Returns:
    
    true if the current row has changed.
  - goDown
```
protected boolean goDown()
```
    Scroll one row up and adjust current row.
    
    Returns:
    
    true if the current row has changed.
  - goDown
```
protected boolean goDown(boolean handleEditing,
                         boolean fireValueChanged,
                         boolean startFromSave)
```
    Scroll one row down and adjust current row.
    
    Parameters:
    
    handleEditing - If true then do startEdit()/stopEdit(com.goldencode.p2j.ui.WidgetId) calls.
    
    fireValueChanged - If true then VALUE-CHANGED event is fired if current row has changed.
    
    startFromSave - true if row leaving procedure execution should start from row save step, i.e. row save, reposition to new row and start edit is executed, while stop edit and ROW-LEAVE trigger
    
    Returns:
    
    true if the current row has changed.
  - goUpWithSelection
```
protected boolean goUpWithSelection(int rowIndex)
```
    Deselect all rows and select the row before the given one.
    
    Parameters:
    
    rowIndex - 0-based index of the base row in the browse mode, the previous row before it will be selected.
    
    Returns:
    
    true if there are rows before the given one.
  - goDownWithSelection
```
protected boolean goDownWithSelection(int rowIndex)
```
    Deselect all rows and select the row after the given one.
    
    Parameters:
    
    rowIndex - 0-based index of the base row in the browse mode, the next row after it will be selected.
    
    Returns:
    
    true if there are rows after the given one.
  - isOnePageScrollingMode
```
protected boolean isOnePageScrollingMode()
```
    4GL has two scrolling modes: "one-page" scrolling mode which is used if the total number of rows is less or equal the page size and the "multi-page" mode. The main difference between these modes is where REPOSITION statement displays the target row is the browse. In "one-page" mode it tries not to scroll browse, if possible; in "multi-page" mode the target row becomes the top row. Additionally, the current mode affects the scrollbar.
    
    Returns:
    
    true if "one-page" scrolling mode is active. false if "multi-page" scrolling mode is active.
  - isRefreshedOnEnable
```
protected boolean isRefreshedOnEnable()
```
    Determines if browse refreshed on browse widget enabling.
    
    Returns:
    
    true
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    Returns:
    
    true if we got any rows from the server.
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow,
                              boolean setAsCurrentRow)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    setAsCurrentRow - Set the new scroll row as the current row.
    
    Returns:
    
    true if we got any rows from the server.
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow,
                              boolean setAsCurrentRow,
                              boolean leaveOnNoRows)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    setAsCurrentRow - Set the new scroll row as the current row.
    
    leaveOnNoRows - Return if there are no rows in the result set (otherwise cache will be cleared).
    
    Returns:
    
    true if we got any rows from the server.
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow,
                              boolean setAsCurrentRow,
                              boolean leaveOnNoRows,
                              boolean ignoreOnePageScrollingMode)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    setAsCurrentRow - Set the new scroll row as the current row.
    
    leaveOnNoRows - Return if there are no rows in the result set (otherwise cache will be cleared).
    
    ignoreOnePageScrollingMode - Perform scroll as if the browse is in multiple-pages scrolling mode.
    
    Returns:
    
    true if we got any rows from the server.
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow,
                              boolean setAsCurrentRow,
                              boolean leaveOnNoRows,
                              boolean ignoreOnePageScrollingMode,
                              boolean honorRepositionedRow)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    setAsCurrentRow - Set the new scroll row as the current row.
    
    leaveOnNoRows - Return if there are no rows in the result set (otherwise cache will be cleared).
    
    ignoreOnePageScrollingMode - Perform scroll as if the browse is in multiple-pages scrolling mode.
    
    honorRepositionedRow - Honor repositioned row set by SET-REPOSITIONED-ROW.
    
    Returns:
    
    true if we got any rows from the server.
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow,
                              boolean setAsCurrentRow,
                              boolean leaveOnNoRows,
                              boolean ignoreOnePageScrollingMode,
                              boolean honorRepositionedRow,
                              boolean allowStartEdit)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    setAsCurrentRow - Set the new scroll row as the current row.
    
    leaveOnNoRows - Return if there are no rows in the result set (otherwise cache will be cleared).
    
    ignoreOnePageScrollingMode - Perform scroll as if the browse is in multiple-pages scrolling mode.
    
    honorRepositionedRow - Honor repositioned row set by SET-REPOSITIONED-ROW.
    
    allowStartEdit - Allow to start editing for the first scroll.
    
    Returns:
    
    true if we got any rows from the server.
  - scrollToRow
```
protected boolean scrollToRow(int scrollRow,
                              boolean setAsCurrentRow,
                              boolean leaveOnNoRows,
                              boolean ignoreOnePageScrollingMode,
                              boolean honorRepositionedRow,
                              boolean allowStartEdit,
                              int oneTimeRepositionedRow,
                              boolean updateSelection)
```
    Scroll to the specified row (all records are refreshed).
    
    Parameters:
    
    scrollRow - The new scroll row (i.e. the first row in the viewport).
    
    setAsCurrentRow - Set the new scroll row as the current row.
    
    leaveOnNoRows - Return if there are no rows in the result set (otherwise cache will be cleared).
    
    ignoreOnePageScrollingMode - Perform scroll as if the browse is in multiple-pages scrolling mode.
    
    honorRepositionedRow - Honor repositioned row set by SET-REPOSITIONED-ROW.
    
    allowStartEdit - Allow to start editing for the first scroll.
    
    oneTimeRepositionedRow - 0-based repositioned row used for this scroll action. -1 if not specified.
    
    updateSelection - true if selection should be adjusted.
    
    Returns:
    
    true if we got any rows from the server.
  - updateLabelsHeight
```
protected void updateLabelsHeight()
```
    Update height of the labels area.
  - nextNewRowNumber
```
protected int nextNewRowNumber()
```
    Get next unique row number for a new row.
    
    Returns:
    
    see above.
  - isFirstBrowseRow
```
protected boolean isFirstBrowseRow()
```
    Determines if the current row is the first browse row, i.e. we cannot scroll higher this row.
    
    Returns:
    
    true if we cannot scroll higher current row.
  - getFirstExistingRow
```
protected int getFirstExistingRow()
```
    Get first existing (not new) row in the view.
    
    Returns:
    
    0-based index (in the browse model) of the first existing row in the view or -1 if there are no existing rows.
  - getLastExistingRow
```
protected int getLastExistingRow()
```
    Get last existing (not new) row in the view.
    
    Returns:
    
    0-based index (in the browse model) of the last existing row in the view or -1 if there are no existing rows.
  - getEdgeExistingRow
```
protected int getEdgeExistingRow(boolean first)
```
    Get first or last existing (not new) row in the view.
    
    Parameters:
    
    first - true to look for the first row. false to look for the last row.
    
    Returns:
    
    0-based index (in the browse model) of the first existing row in the view or -1 if there are no existing rows.
  - parentFrameViewed
```
public void parentFrameViewed()
```
    Notify browse that the parent frame became visible. That means that the browse should be refreshed and displayed.
  - isEditPossible
```
public boolean isEditPossible()
```
    Determine if in-browse editing is possible.
    
    Returns:
    
    true if there is at least one editable column.
  - getInvisibleColumns
```
public BrowseColumnConfig[] getInvisibleColumns()
```
    Return information about invisible columns.
    
    Returns:
    
    Meta information about invisible columns.
  - dcGetRowIndex
```
protected int dcGetRowIndex(int rowIndex)
```
    Calculate row index for internal cache.
    
    Parameters:
    
    rowIndex - Index in the model.
    
    Returns:
    
    Calculated index in the local cache.
  - invokeLeaveCellTrigger
```
public boolean invokeLeaveCellTrigger(WidgetId nextFocus)
```
    Invoke the LEAVE trigger for the currently editable column.
    
    Parameters:
    
    nextFocus - The next focusable widget.
    
    Returns:
    
    true if the LEAVE trigger allows the leave.
  - invokeRowEntryTrigger
```
public boolean invokeRowEntryTrigger()
```
    Invoke ROW-ENTRY trigger.
    
    Returns:
    
    true if there is no ROW-ENTRY trigger or it has returned normally. false if NO-APPLY has been returned by the trigger.
  - invokeRowEntryTrigger
```
public boolean invokeRowEntryTrigger(WidgetId leaveWidgetId)
```
    Invoke ROW-ENTRY trigger.
    
    Parameters:
    
    leaveWidgetId - ID of the widget left.
    
    Returns:
    
    true if there is no ROW-ENTRY trigger or it has returned normally. false if NO-APPLY has been returned by the trigger.
  - hasRows
```
public boolean hasRows()
```
    Gets a value that indicates whether the browse contains one or more rows (including new rows).
    
    Returns:
    
    true if the browse contains one or more rows.
  - resetFirstEditing
```
public void resetFirstEditing()
```
    Set firstEditing flag to false.
  - invokeRowLeaveTrigger
```
public Browse.RowLeaveResult invokeRowLeaveTrigger(WidgetId nextId)
```
    Invoke ROW-LEAVE trigger.
    
    Parameters:
    
    nextId - The ID of the next focusable widget.
    
    Returns:
    
    row leave result.
  - leaveRow
```
protected Browse.RowLeaveResult leaveRow()
```
    Release current row (finish editing and commit). If row cannot be released (e.g. validation fails), scroll to editable row and restart editing, if necessary.
    
    Returns:
    
    row leave result.
  - leaveRow
```
protected Browse.RowLeaveResult leaveRow(boolean startFromSave)
```
    Release current row (finish editing and commit). If row cannot be released (e.g. validation fails), scroll to editable row and restart editing, if necessary.
    
    Parameters:
    
    startFromSave - true if row leaving procedure execution should start from row save step, i.e. row save, reposition to new row and start edit is executed, while stop edit and ROW-LEAVE trigger invocation is omitted.
    
    Returns:
    
    row leave result.
  - leaveRow
```
protected Browse.RowLeaveResult leaveRow(boolean startFromSave,
                                         WidgetId nextId)
```
    Release current row (finish editing and commit). If row cannot be released (e.g. validation fails), scroll to editable row and restart editing, if necessary.
    
    Parameters:
    
    startFromSave - true if row leaving procedure execution should start from row save step, i.e. row save, reposition to new row and start edit is executed, while stop edit and ROW-LEAVE trigger invocation is omitted.
    
    nextId - ID of the next focusable widget.
    
    Returns:
    
    row leave result.
  - scrollToEditableRow
```
protected void scrollToEditableRow()
```
    Scroll to the editable row if it is out of the view.
  - getFirstEditableColumn
```
private int getFirstEditableColumn()
```
    Get the first editable column in the browse.
    
    Returns:
    
    0-based index of the first editable column among the visible columns or -1 if there is no editable column.
  - getVisibleColumns
```
protected BrowseColumnConfig[] getVisibleColumns()
```
    Return information about visible columns.
    
    Returns:
    
    Meta information about visible columns.
  - getColumns
```
protected BrowseColumnConfig[] getColumns()
```
    Return information about all columns regardless of their visibility.
    
    Returns:
    
    Meta information about all columns.
  - resetColumnsCache
```
protected void resetColumnsCache()
```
    Reset cached information about columns.
  - updateMaxDataGuess
```
protected void updateMaxDataGuess(boolean lastReached)
```
    Update MAX-DATA-GUESS value which holds estimated number of rows.
    
    Parameters:
    
    lastReached - true if the last row in the browse model has been reached.
  - notifyBrowseScrolled
```
protected void notifyBrowseScrolled()
```
    Notify that the browse has been scrolled (i.e. the top row has changed).
  - ordinalToVisible
```
protected java.lang.Integer ordinalToVisible(int columnOrdinal)
```
    Get 0-based index of the column among the visible columns.
    
    Parameters:
    
    columnOrdinal - Column ordinal, i.e. 0-based index of the column among all columns
    
    Returns:
    
    0-based index of the column among the visible columns or null if the column is not visible.
  - visibleToOrdinal
```
protected int visibleToOrdinal(int visibleColumnIndex)
```
    Get 0-based index of the column among all columns (i.e. column ordinal).
    
    Parameters:
    
    visibleColumnIndex - 0-based index of the column among the visible columns.
    
    Returns:
    
    0-based index of the column among all columns (i.e. column ordinal).
  - populateColumnsCache
```
protected void populateColumnsCache()
```
    Populate cache of columns using updated BrowseConfig.columnIds.
  - getNumberForLastRow
```
protected int getNumberForLastRow()
```
    Get a big number that can be used in getRows(int, int, boolean, RowDisplayStrategy) to make it return the last row in the result set.
    
    Returns:
    
    a big number used to get the last row in the result set.
  - setCurrentRowSelected
```
protected boolean setCurrentRowSelected()
```
    Select current row for single-selection case.
  - triggerOffEnd
```
protected void triggerOffEnd(boolean noRowsTriggers)
```
    Triggers the OFF-END event when the browse has an open query.
    
    Parameters:
    
    noRowsTriggers - true triggers off-end even when the browse is empty.
  - triggerOffEnd
```
protected void triggerOffEnd(boolean noRowsTriggers,
                             boolean triggeredByScrollbar)
```
    Triggers the OFF-END event when the browse has an open query.
    
    Parameters:
    
    noRowsTriggers - true triggers off-end even when the browse is empty.
    
    triggeredByScrollbar - true if the function is triggered by a scrollbar.
  - isAnyRowSelected
```
private boolean isAnyRowSelected()
```
    Returns true if the browse has any selected row, false otherwise.
    
    Returns:
    
    See above.

Class Browse<O extends OutputManager<?>>

Nested Class Summary

Field Summary

Fields inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.ui.client.FixedSizeContainer

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractContainer

Methods inherited from class com.goldencode.p2j.ui.client.widget.AbstractWidget

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Container

Methods inherited from interface com.goldencode.p2j.ui.client.widget.Widget

Methods inherited from interface java.awt.event.MouseListener

Methods inherited from interface java.awt.event.MouseMotionListener

Methods inherited from interface java.awt.event.MouseWheelListener

Field Detail

CACHE_SIZE

LOG

NEW_ROWS_NUMERATION_START

browseModel

currRowSelected

hadRowSelected

lastRowSelected

currColumn

currRowUpdates

selectedRowIndices

scrollColumn

ilLabelsHeight

ilFirstScrollCol

dcData

rcLabels

config

drawLabels

browseStateHandler

currentRow

currentRowAvail

awaitingEndError

newRowNumber

hadDraw

pseudoFocus

rowCountAssessment

pendingExtraRowFetch

separatorQuirk

originalWidth

originalHeight

editedRow

savingRow

layoutNotificationSent

colorCurrent

colorHSep

activeEditor

insertRowInfo

editingExistingRowBefore

colorCommon

columnsCache

visibleColumnsCache

ordinalToVisibleMap

currentRowDisplayStrategy

intermediateDcData

navigable

initialRow

columnsInUpdate

insertingRow

keepEditingColumn

queryClosed

initialDataSetObtained

rowEntryTriggers

columnEntryTriggerDepth

queryInitialized

firstEditing

inRowLeaveTrigger

pendingRowLeaveSave

Constructor Detail

Browse

Method Detail

notifyColumnsUpdated

notifyColumnsUpdated

refreshColumnAttributes

startEditOnFocusGained

getScrollRow