FileDropComboClass Functional Organization - Expected Use


Top  Previous  Next

As an aid to understanding the FileDropComboClass, it is useful to organize its 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 FileDropComboClass 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:

Housekeeping (one-time) Use:

 

Init

initialize the FileDropComboClass object

 

AddField (i)

specify display fields

 

AddUpdateField (i)

specify field assignments

 

AddRange (ii)

add a range limit to the active sort order

 

AppendOrder (ii)

refine the active sort order

 

KillI

shut down the FileDropComboClass object

Mainstream Use:

 

ResetQueue

refresh filedrop queue

 

GetQueueMatch

locate a list item

 

AskV

add a record to the lookup file

 

TakeEvent (v)

process the current ACCEPT loop event

 

TakeNewSelection (v)

process the EVENT:Selected events

Occasional Use:

 

Open (ii)

open the filedrop view

 

PrimeRecord (ii)

prepare an item for adding

 

SetFilter (ii)

specify a filter for the active sort order

 

ApplyFilter (ii)

range limit and filter the result set

 

ApplyOrder (ii)

sort the result set

 

GetFreeElementName (ii)

return the free element field name

 

SetOrder (ii)

replace the active sort order

 

Close (ii)

close the filedrop view

(i) These methods are inherited from the FileDropClass.

(ii) These methods are inherited from the ViewManager.

(v) These methods are also virtual methods

 

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.

 

Ask

add a record to the lookup file

 

SetQueueRecord (i)

copy data from file buffer to queue buffer

 

Reset (ii)

reset the view position

 

TakeEvent

process the current ACCEPT loop event

 

TakeNewSelection

process the EVENT:Selected events

 

ValidateRecord (i)

validate the current result set element

(i) These methods are inherited from the FileDropClass.

(ii) These methods are inherited from the ViewManager.