Namespace: Consultingwerk.WindowIntegrationKit.Controls
Class 
AblBrowseWidgetApi Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.WindowIntegrationKit.Controls.AblBrowseWidgetApi

Inherits: Progress.Lang.Object
Implements: Consultingwerk.WindowIntegrationKit.Controls.IBrowseApi

File:AblBrowseWidgetApi
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Thu Jul 11 18:40:54 CEST 2013

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ApplyEntry () Applies entry to the browse widget
+ ApplyEntryToCell (character) Applies entry to a cell of a browse widget
+ ApplyEntryToCell (handle) Applies entry to a cell of a browse widget
+ LOGICAL DELETE-CURRENT-ROW () Deletes the most recently selected row from a browse and the results list.
+ LOGICAL DELETE-SELECTED-ROW (integer) Deletes the nth selected row from a browse and the results list.
+ LOGICAL DELETE-SELECTED-ROWS () Deletes all currently selected rows from a browse and the associated results list.
+ LOGICAL DESELECT-FOCUSED-ROW () Deselects the row with current focus.
+ LOGICAL DESELECT-ROWS () Deselects all currently selected rows in the browse and clears the associated record buffer.
+ LOGICAL DESELECT-SELECTED-ROW (integer) Deselects the nth selected row in a browse
+ LOGICAL FETCH-SELECTED-ROW (integer) Fetches the piRow'th selected row in a browse and puts the row into the database buffer. In other words, this method specifies one row from the one-based index into all currently selected rows and puts that row into the record buffer.
+ INTEGER GET-REPOSITIONED-ROW () Returns the row index of the browse viewport where the REPOSITION TO ROWID (or RECID) statement displays a repositioned record.
+ LOGICAL IS-ROW-SELECTED (integer) Returns TRUE if a specified row in the browse viewport is currently selected.
+ LOGICAL Refresh () Forces the AVM to refresh the display of the current rows in a browse.
+ LOGICAL REPOSITION-TO-ROW (integer) Moves a query objects result list pointer to the row corresponding to the specified sequence number.
+ LOGICAL SCROLL-TO-SELECTED-ROW (integer) Scrolls a browse (if necessary) to bring a specified selected row into view
+ LOGICAL SELECT-ALL () Selects all rows in a query connected to the browse.
+ LOGICAL SELECT-FOCUSED-ROW () Selects the row that currently has focus in a browse widget, even if it is not currently displayed.
+ LOGICAL SELECT-NEXT-ROW () Deselects all currently selected rows in a browse and selects the row after the deselected row.
+ LOGICAL SELECT-PREV-ROW () Deselects a currently selected row in a browse and selects the row before the deselected row.
+ LOGICAL SELECT-ROW (integer) Selects the specified row if it is currently in the browse viewport. In a single-select browse, the previously selected row is deselected.
+ LOGICAL SET-REPOSITIONED-ROW (integer, character) Sets the row index where records positioned with the REPOSITION TO ROWID (or RECID) statement are displayed.

Top Constructor Summary
Options Name Purpose
+ AblBrowseWidgetApi (handle) Constructor for the AblBrowseWidgetApi class

Top Property Summary
Options Name Purpose
+ HANDLE CURRENT-COLUMN The value of the browse column that contains the current cell. This attribute moves focus to the cell in the specified column in the current row.
+ INTEGER NUM-ITERATIONS The number of currently visible foreground iterations for a frame or the number of rows currently visible in a browse widget.
+ INTEGER NUM-LOCKED-COLUMNS The number of visible leading columns locked in a browse widget.
+ INTEGER NUM-SELECTED-ROWS Returns the number of selected rows
+ HANDLE QUERY Returns the Query used by the Browse


Method Detail
Top

PUBLIC ApplyEntry ()
Purpose: Applies entry to the browse widget
Notes:

Top

PUBLIC ApplyEntryToCell (character)
Purpose: Applies entry to a cell of a browse widget
Notes:

Parameters:
pcColumnName CHARACTER
The short name of the browse column
Top

PUBLIC ApplyEntryToCell (handle)
Purpose: Applies entry to a cell of a browse widget
Notes:

Parameters:
phColumn HANDLE
The handle of a browse column
Top

PUBLIC LOGICAL DELETE-CURRENT-ROW ()
Purpose: Deletes the most recently selected row from a browse and the results list.
Notes: This method does not delete the record from the database and has no effect
on the database buffer. If you then want to delete the database record
associated with the row, use the DELETE statement.

Returns LOGICAL
If the row is successfully deleted from the browse and results list, the method returns TRUE.
Top

PUBLIC LOGICAL DELETE-SELECTED-ROW (integer)
Purpose: Deletes the nth selected row from a browse and the results list.
Notes: This method does not delete the record from the database and has no
effect on the database buffer. If you want to delete the database
record associated with the row, use the DELETE statement.

Parameters:
piRow INTEGER
An integer expression that specifies a selected row within the browse.
Returns LOGICAL
If the row is successfully deleted, the method returns TRUE.
Top

PUBLIC LOGICAL DELETE-SELECTED-ROWS ()
Purpose: Deletes all currently selected rows from a browse and the associated
results list.
Notes: Do not confuse the DELETE-SELECTED-ROW method (note the singular)
with the DELETE-SELECTED-ROWS method (note the plural).
This method does not delete the record from the database and has no
effect on the database buffer. If you want to delete the database
record associated with the row, use the DELETE statement.

Returns LOGICAL
If the row is successfully deleted, the method returns TRUE.
Top

PUBLIC LOGICAL DESELECT-FOCUSED-ROW ()
Purpose: Deselects the row with current focus.
Notes: This method is ignored on single-select browse widgets, because
focus follows selection.

Returns LOGICAL
Logical value, TRUE
Top

PUBLIC LOGICAL DESELECT-ROWS ()
Purpose: Deselects all currently selected rows in the browse and clears the
associated record buffer.
Notes:

Returns LOGICAL
If the rows are successfully deselected, the method returns TRUE.
Top

PUBLIC LOGICAL DESELECT-SELECTED-ROW (integer)
Purpose: Deselects the nth selected row in a browse
Notes: The AVM maintains a numbered list of selected rows, starting at 1.
When the DESELECT-SELECTED-ROW (n) method is encountered, the AVM
searches this list to find the nth selected row.

Parameters:
piRow INTEGER
An integer expression that specifies a selected row within the browse.
Returns LOGICAL
If the row is successfully deselected, the method returns TRUE.
Top

PUBLIC LOGICAL FETCH-SELECTED-ROW (integer)
Purpose: Fetches the piRow'th selected row in a browse and puts the row into
the database buffer. In other words, this method specifies one row
from the one-based index into all currently selected rows and puts
that row into the record buffer.
Notes:

Parameters:
piRow INTEGER
An integer expression that specifies a selected row within the browse.
Returns LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC INTEGER GET-REPOSITIONED-ROW ()
Purpose: Returns the row index of the browse viewport where the REPOSITION
TO ROWID (or RECID) statement displays a repositioned record.
Notes:

Returns INTEGER
The row index of the browse viewport where the REPOSITION TO ROWID (or RECID) statement displays a repositioned record.
Top

PUBLIC LOGICAL IS-ROW-SELECTED (integer)
Purpose: Returns TRUE if a specified row in the browse viewport is currently
selected.
Notes: The AVM maintains a numbered list of selected rows, starting at 1.

Parameters:
piRow INTEGER
An integer expression that specifies a selected row within the browse viewport.
Returns LOGICAL
Logical value indicating if a specified row in the browse viewport is currently selected.
Top

PUBLIC LOGICAL Refresh ()
Purpose: Forces the AVM to refresh the display of the current rows in a browse.
Notes:

Returns LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC LOGICAL REPOSITION-TO-ROW (integer)
Purpose: Moves a query objects result list pointer to the row corresponding
to the specified sequence number.
Notes: The REPOSITION-TO-ROW method corresponds to the REPOSITION statement
with the TO ROW option.

Parameters:
piRow INTEGER
An integer expression representing the sequence number.
Returns LOGICAL
Logical value, always TRUE
Top

PUBLIC LOGICAL SCROLL-TO-SELECTED-ROW (integer)
Purpose: Scrolls a browse (if necessary) to bring a specified selected row
into view
Notes:

Parameters:
piRow INTEGER
An integer expression that specifies a selected row within the browse
Returns LOGICAL
If the row is successfully scrolled into view (or if the scroll is unnecessary), the method returns TRUE
Top

PUBLIC LOGICAL SELECT-ALL ()
Purpose: Selects all rows in a query connected to the browse.
Notes:

Returns LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC LOGICAL SELECT-FOCUSED-ROW ()
Purpose: Selects the row that currently has focus in a browse widget, even if
it is not currently displayed.
Notes: This method repositions the query to that row and copies the record
into the database buffer. The browse automatically scrolls to the
selected row. You can use this method after a REPOSITION statement
to position a query to a selected row.

Returns LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC LOGICAL SELECT-NEXT-ROW ()
Purpose: Deselects all currently selected rows in a browse and selects the
row after the deselected row.
Notes: 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 LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC LOGICAL SELECT-PREV-ROW ()
Purpose: Deselects a currently selected row in a browse and selects the row
before the deselected row.
Notes: 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 LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC LOGICAL SELECT-ROW (integer)
Purpose: Selects the specified row if it is currently in the browse viewport.
In a single-select browse, the previously selected row is deselected.
Notes: No rows are deselected in a multiple-select browse.

Parameters:
piRow INTEGER
An integer expression specifying the ordinal position of a row within the browse.
Returns LOGICAL
Logical value indicating if the selected action was successful
Top

PUBLIC LOGICAL SET-REPOSITIONED-ROW (integer, character)
Purpose: Sets the row index where records positioned with the REPOSITION TO
ROWID (or RECID) statement are displayed.
Notes: Currently not yet supports

Parameters:
piRowIndex INTEGER
Indicates the row number where the new record is displayed, 1 being the first row.
pcRepositionMode CHARACTER
ALWAYS or CONDITIONAL
Returns LOGICAL
Logical value indicating the success of the method


Constructor Detail
Top

PUBLIC AblBrowseWidgetApi (handle)
Purpose: Constructor for the AblBrowseWidgetApi class
Notes:

Parameters:
phBrowse HANDLE
The handle of the ABL Browse Widget for this instance


Property Detail
Top

PUBLIC HANDLE CURRENT-COLUMN
Purpose: The value of the browse column that contains the current cell. This
attribute moves focus to the cell in the specified column in the current
row.
Notes: For the browse, if the browse or a browse component currently has focus,
then setting the attribute to another column causes the proper LEAVE
and cell ENTRY events to happen.
If the setting of the CURRENT-COLUMN attribute happens when focus is
outside of the browse, then the browses internal handle to the current
column is updated so that it will become the current column when you tab
back into the browse. Also if you apply "START-SEARCH" the search mode
will now use this column to search on.

Returns HANDLE
Top

PUBLIC INTEGER NUM-ITERATIONS
Purpose: The number of currently visible foreground iterations for a frame
or the number of rows currently visible in a browse widget.
Notes:

Returns INTEGER
Top

PUBLIC INTEGER NUM-LOCKED-COLUMNS
Purpose: The number of visible leading columns locked in a browse widget.
Notes: If a locked column is hidden, the next visible non-locked column in
the browse will then become locked.
When you use the horizontal scrollbar to scroll columns in the browse,
locked columns do not move. For example, if NUM-LOCKED-COLUMNS is 3,
then the three leftmost columns in the browse are locked.

Returns INTEGER
Top

PUBLIC INTEGER NUM-SELECTED-ROWS
Purpose: Returns the number of selected rows
Notes:

Returns INTEGER
Top

PUBLIC HANDLE QUERY
Purpose: Returns the Query used by the Browse
Notes:

Returns HANDLE


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:47:07