BrowseClass Functional Organization - Expected Use 

Top  Previous  Next

As an aid to understanding the BrowseClass, it is useful to organize its various methods into two large categories according to their expected use--the primary interface and the virtual methods. This organization reflects what we believe is typical use of the BrowseClass methods.

Non-Virtual Methods

The Non-Virtual Methods, which you are likely to call fairly routinely from your program, can be further divided into three categories:

(v) indicates that these methods are also Virtual.

Housekeeping (one-time) Use:

 

Init

initialize the BrowseClass object

 

AddEditControl

specify custom edit-in-place for a browse field

 

AddField

identify corresponding FILE and QUEUE fields

 

AddLocator

associate a locator with its sort order

 

AddResetField

specify a field that refreshes the browse list

 

AddSortOrder

add a sort order to the browse list

 

AddToolbarTarget

associate the browse list with a toolbar object

 

SetAlerts (v)

alert keys for list, locator, and edit controls

 

Kill (v)

shut down the BrowseClass object

Mainstream Use:

 

Next (v)

get the next view record in sequence

 

Previous (v)

get the previous view record in sequence

 

Ask

update the selected item

 

TakeEvent (v)

process the current ACCEPT loop event

 

TakeNewSelection (v)

process a new browse list item selection

 

Occasional Use:

 

ApplyRange

refresh browse list to specified range limit

 

AskRecord

edit-in-place the selected item

 

PostNewSelection

post an EVENT:NewSelection to the browse list

 

Records

return the number of records in the browse list

 

ResetResets

snapshot the current value of the Reset fields

 

ResetThumbLimits

reset thumb limits to match the result set

 

TakeAcceptedLocator

apply an entered locator value

 

UpdateResets

copy reset fields to file buffer

 

UpdateThumb

position the scrollbar thumb

 

UpdateThumbFixed

position the scrollbar fixed thumb

 

UpdateWindow (v)

apply pending scroll, locator, range, etc.

Virtual Methods

Typically you will not call these methods directly--the Non-Virtual Methods call them. However, we anticipate you will often want to override these methods, and because they are virtual, they are very easy to override. These methods do provide reasonable default behavior in case you do not want to override them.

 

ApplyRange

conditionally range limit and filter the records

 

Fetch

loads a page of items into the browse list

 

Kill

shut down the BrowseClass object

 

Next

get the next record from the browse view

 

Previous

get the previous record from the browse view

 

Reset

reset the view position

 

ResetFromAsk

reset browse object after update

 

ResetFromBuffer

refill queue based on current record buffer

 

ResetFromFile

refill queue based on FILE POSITION

 

ResetFromView

reset browse object to its result set

 

ResetQueue

fill or refill the browse queue

 

ScrollEnd

scroll to the first or last item

 

ScrollOne

scroll up or down one item

 

ScrollPage

scroll up or down one page of items

 

SetAlerts

alert keys for list, locator, and edit controls

 

SetQueueRecord

copy data from file buffer to queue buffer

 

SetSort

apply sort order to browse

 

ResetSort

apply sort order to browse

 

TakeKey

process an alerted keystroke

 

TakeEvent

process the current ACCEPT loop event

 

TakeNewSelection

process a new browse list item selection

 

TakeScroll

process a scroll event

 

TakeVCRScroll

process a VCR scroll event

 

UpdateBuffer

copy data from queue buffer to file buffer

 

UpdateViewRecord

copy selected item to corresponding file buffers

 

UpdateWindow

apply pending scroll, locator, range, etc.

 

Use ResetSort followed by UpdateWindow to refresh and redisplay your ABC BrowseBoxes. Or, use the WindowManager.Reset method.