Class: nesting_mixin

Module location: nesting.pkg line 95 (view source)

Class Hierarchy:

cObjectMixinnesting_mixin

Class Definition

Properties

integerComponent_State
integerFirst_DEO
integerHas_Components_State
integerLast_DEO
integerStop_UI_State
Stop_ui support - Moved from its own mixin package.

Functions and Procedures

IntegerDeactivate(Integer eDeactivateScope)
Description Removes this object from the screen and focus-tree, and also removes this object's children from the screen and focus-tree. Assumptions/Preconditions This object must understand Client_Area_State. Exceptions None. Notes If no flag argument was passed, AREA_TYPE becomes the flag parameter. Client-objects already automatically remove their children from the focus-tree. 12/16/94 JJT- Altered so no param is not forwarded, Added stop_ui
define_nesting()
Description This procedure defines the properties required to support the nesting of data-entry objects. Assumptions/Preconditions This procedure should only be invoked from within the Construct_Object procedure of a class definition. Exceptions None. Notes Component_State indicates if this object has a parent object which is also a data-entry object. Has_Components_State indicates if this object has at least one child- object which is also a data-entry object. First_DEO and Last_DEO are used temporarily during the searches for the first and last data-entry object children of this object (see Find_First_DEO, Find_Last_DEO, Inquire_First_DEO and Inquire_Last_DEO).
integerfind_first_DEO()
Description This function returns the object id of the first data-entry object which is a child of this object, or 0. Assumptions/Preconditions None. Exceptions None. Notes This function 'searches' by broadcasting Inquire_First_DEO, which returns a 1 to terminate the broadcast after the first data-entry object has been located.
integerfind_last_DEO()
Description This function returns the object id of the last data-entry object which is a child of this object, or 0. Assumptions/Preconditions None. Exceptions None. Notes This function 'searches' by broadcasting Inquire_Last_DEO, which sets the property Last_DEO. Thus, the last object reached by the broadcast is the last value to be set into Last_DEO.
inquire_first_DEO(integer obj# integer recurseClients)
Description If this object is focusable, set First_DEO to this object's id and return a non-zero value to terminate the parent object's BROADCAST. This procedure is used to locate the first data-entry object among this object's siblings (its parent's children). Assumptions/Preconditions None. Exceptions None. Notes This procedure is typically invoked via the BROADCAST command from the Find_First_DEO function of this object's parent.
inquire_last_DEO(integer obj# integer recurseClients)
Description If this object is focusable, set Lastt_DEO to this object's id. This procedure is used to locate the last data-entry object among this object's siblings (its parent's children). Assumptions/Preconditions None. Exceptions None. Notes This procedure is typically invoked via the BROADCAST command from the Find_Last_DEO function of this object's parent.
Mark_As_Component()
Description This procedure marks an object as a child data-entry object, and attempts to use its parent's Server if this object has no Server. Assumptions/Preconditions None. Exceptions None. Notes Typically senbt via broadcast from parent DEO.
Mark_Components()
Description This procedure marks child data-entry objects as components. Assumptions/Preconditions The child data-entry objects must understand Mark_As_Component as a method of setting their Component_State to TRUE. Exceptions None. Notes Invoked by the DEOEnd macro (which manages completion of an object declaration).