Class: DataList

Module location: Dfdata.pkg line 28 (view source)

Class Hierarchy:

DFBaseEntryListEntryListWideList_WideListDataList_DataList

Direct Known Subclasses:

dbGrid_, dbList_,

Class Definition

Properties

integerCrntThumbPos
IntegerCurrent_Position
private for prompt and spin stuff
IntegerCustomScrollState
integerFindAtEndState
integerLastFindLTState
IntegerpbEmbeddedPrompts
Prompt and Spin button support If true, prompts added automatically to columns that prompt objects
booleanpbHeaderTogglesDirection
this determines if clicking on header changes ordering direction
stringpsEmbeddedButtonValue
text for embedded prompt buttons
integerSBRange
these are all private
IntegerScrollOnThumbTrackState
IntegerThumbScrollState

Functions and Procedures

Beg_End_Data(Integer Direction Integer NoSave)
Inherited from Data_List_mixin
augment to set last direction, find at end and trigger a scroll bar change
integerColumn_Button(integer iCol)
prompt and spin button messages for columns Get/set Column_Button to FORM_BUTTON_NONE|FORM_BUTTON_PROMPT|FORM_BUTTON_SPIN|FORM_BUTTON_SPIN_WRAP get/set Column_Minumum_position get/set Column_Maximum_position
BooleanColumn_CapsLock_State(integer iCol)
BooleanColumn_Checkbox_State(integer iCol)
HandleColumn_Entry_msg(integer iCol)
HandleColumn_Exit_msg(integer iCol)
integerColumn_Maximum_Position(integer iCol)
integerColumn_Message(integer hmMsg integer iCol)
integerColumn_Minimum_Position(integer iCol)
integerColumn_Option(integer iCol integer iOption)
integerColumn_Options(integer iCol)
HandleColumn_Prompt_Object(integer iCol)
BooleanColumn_Shadow_State(integer iCol)
HandleColumn_Validate_msg(integer iCol)
HandleColumn_Zoom_Object(integer iCol)
Construct_Object()
Inherited from Data_List_mixin
integerDEO_Control_Object()
Returns TRUE to indicate that this is a DEO control. This is used by if you are within a DEO control message and should therefore send a DEO message.
DoDisplayCheckBox(integer iItm integer bSt)
This can be called from with entry_display to display a checkbox. This is used for non-data entry checkboxes (most often in sel-lists). Displays a checkbox for the item passed based on passed state. Display different ckboxes for displayonly and not. This can be sent to display a checkbox. If a developer wishes to use different bitmaps, they can augment this message.
Establish_Find_Mode(Integer mode)
Inherited from Data_List_mixin
augment to keep track of find direction, used by scrollbar
Header_Mouse_Click(Integer iItem)
Inherited from Standard_Grid_Mixin
augmented to change ordering direction of pbHeaderTogglesDirection is set. Only do this if the selected column is already the selected column, if not forward, which will do the normal column change and new index thing, if needed.
Insert_Row(integer row#)
Inherited from Data_List_mixin
IntegerLoad_Page(Integer Row#)
Inherited from Data_List_mixin
augment to set scroll info (it is needed to set the thumb)
OnBeginningOfPanel()
Inherited from Shadow_Mixin
augment to always force the first column to be visible. This will occur during a panels clear or save. It makes sense to restore the column. If you do no want this behavior just cancel it.
OnInitSpin()
Inherited from Standard_Grid_Mixin
Read_Next_Record()
Inherited from Data_List_mixin
augment to set findatend. We use this to position the scrollbar
set(integer row integer col)
Inherited from Data_List_mixin
augmented to check if number of rows changed so we can support dynamic resizing of non-batch lists.
Set(integer hmMsg integer iCol integer iParam)
Inherited from Data_List_mixin
Create interface to more easily get at column options: This allows the developer to easiy get at all of the {...} items in a dbGrid or dbList. Get/Set Column_Options Get/Set Column_Option Get/Set Column_Shadow_State Get/Set Column_Capslock_State Get/Set Column_Prompt_Object Get/Set Column_Zoom_Object Get/Set Column_Entry_msg Get/Set Column_Exit_msg Get/Set Column_Validate_msg Get/Set Column_Message (generic: Pass Msg number, column, integer param) Advanced Message: This is used to get/set the column message for the passed message number. Other public column messages use this. When SET : Pass message number, column, Integer param to Set. When GET : Pass message number, column and return Integer param sets items in protoype object and items in grid
Set(integer iCol integer iOptions)
Inherited from Data_List_mixin
Get/Set Column_Options
Set(integer iCol integer iOption integer bState)
Inherited from Data_List_mixin
Get/Set Column_Option. sets items in protoype object and items in grid
Set(integer iCol Boolean bState)
Inherited from Data_List_mixin
Get/Set Column_Shadow_State
Set(integer iCol Boolean bState)
Inherited from Data_List_mixin
Get/Set Column_Capslock_State
Set(integer iCol Handle hObj)
Inherited from Data_List_mixin
Get/Set Column_Prompt_Object
Set(integer iCol Handle hObj)
Inherited from Data_List_mixin
Get/Set Column_Zoom_Object
Set(Integer iCol Handle hmMsg)
Inherited from Data_List_mixin
Get/Set Column_Entry_msg
Set(Integer iCol Handle hmMsg)
Inherited from Data_List_mixin
Get/Set Column_Exit_msg
Set(Integer iCol Handle hmMsg)
Inherited from Data_List_mixin
Get/Set Column_Validate_msg
set(integer iCol Boolean bSelect)
Inherited from Data_List_mixin
Get/Set Column_checkbox_state
Set(integer iCol integer eMode)
Inherited from Data_List_mixin
set(integer iCol integer iPos)
Inherited from Data_List_mixin
set(integer iCol integer iPos)
Inherited from Data_List_mixin
set(integer iNewTop integer iNewCurrent)
Inherited from Data_List_mixin
the DFBaseEntryList class has it's own special Set_Top_item message (as of 9.0) which does not set current_item. When used for non-batch lists, we don't want the set_current_item and that is why it was removed. This fixes a problem when scrolling down/up when the entire grid is shifted horizontally to the right. When you scroll, the grid would shift to col 0. However, with batch lists we want the normal set_top_item or we get other problems. So we we modify the method here to make it do a normal top_item (ie. set current_item).
SetVScrollbox(Integer iType Integer iData)
SetVScrollInfo(Integer iMin Integer iMax Integer iPage)
SetVScrollPos(Integer iPos)

References (2):

ModuleContaining SymbolLine
Dfsellst.pkgdbList_93
Dftable.pkgdbGrid_51