skip to main content
OpenEdge Development: ADM Reference
Toolbar Objects and Their Methods and Properties : Panel methods for toolbar objects
 
Panel methods for toolbar objects
This section lists and describes the methods for panel Toolbar Objects.
activeTarget
Return the targets of the specified link type.
Location: panel.p
Parameters:  
INPUT pcLink AS CHARACTER
The type of link: TableIO, Navigation, Commit.
Returns: HANDLE
Notes:  
*The toolbar only supports one active object in these, but it might be linked to inactive objects on hidden pages. If more than one target this procedure returns the active hidden object where ObjectHidden = FALSE for some link type.
*This is not overridden by Toolbar.
countButtons
Procedure that walks the widget tree of the frame, counts all the buttons, and sets the ButtonCount property.
Location: panel.p
Parameters: None
Note: This sets the Panel property ButtonCount. For internal use only.
disableActions
Disables a specified list of actions.
Location: panel.p
Parameters:  
INPUT pcActions AS CHARACTER
A comma-separated list of actions to be disabled. "*" means All.
Returns: LOGICAL
Note: This function is used internally to turn actions on/off depending on the state. Use modifyDisabledActions or setDisabledActions to override enabling.
enableActions
Enables a specified list of actions.
Location: panel.p
Parameters:  
INPUT pcActions AS CHARACTER
A comma-separated list of actions to be enabled. "*" means All.
Returns: LOGICAL
Note: This function is used internally to turn actions on/off depending on the state. Use modifyDisabledActions or setDisabledActions to override enabling.
enableObject
Procedure that restores the panel buttons to their previous state whenever the panel is re-enabled.
Location: panel.p
Parameters: None
Note: The correct state is the state that the buttons were in before the SmartPanel was disabled. This might not be the initial state. If a SmartPanel has been disabled because the page it is on was hidden, its previous state must be restored when the page is viewed again.
hasActiveGATarget
Checks to determine whether any group assign targets are active.
Location: panel.p
Parameters:  
INPUT phObject AS HANDLE
phObject – Procedure object that is tableioTarget and potential GroupAssignTarget.
Returns: LOGICAL PRIVATE
Notes: None
initializeObject
Procedure used for SmartPanel-specific initialization.
Location: panel.p
Parameters: None
Notes:  
*A SmartPanel is set to the appropriate state depending on its Navigation–Target or Update–Target. A Navigation SmartPanel retrieves the QueryPosition property of its Navigation–Target to determine which buttons to enable. These QueryPosition values map to the value of the PanelState property that is set in the SmartPanel:
*FirstRecord — maps to first.
*LastRecord — maps to last.
*NotFirstOrLast — maps to enable–all.
*NoRecordAvailable — maps to disable–all.
*An Update Panel retrieves the RecordState property of its Update–Target to do the same thing. These changes to the PanelState property are interpreted by the setButtons procedure in the SmartPanels:
*NoRecordAvailable — maps to add–only.
*NoRecordAvailableExt — maps to disable–all.
*RecordAvailable — maps to initial.
linkState
Receives messages when an object linked to this object becomes active or activeTarget (when it is viewed) or inactive or inactiveTarget (when it is hidden).
Location: panel.p
INPUT PARAMETER pcState AS CHARACTER
State of a linked object. Valid states are:
*active
*activeTarger
*inactive
*inactiveTarget
loadPanel
Procedure that loads actions.
Location: panel.p
Parameters: None
Notes: None
onChoose
Procedure that reads actions and parameters from Action class (Repository) and publishes the call built from them.
Location: panel.p
Parameters:  
INPUT pcAction AS CHARACTER
The action to be undertaken.
Notes: None
queryPosition
Procedure that captures state events for the associated Query in the Panel’s NavigationTarget. Invokes the setPanelState function, which stores the new state in the object’s PanelState property and then invokes the setButtons procedure to change the Panel.
Location: panel.p
Parameters:  
INPUT pcState AS CHARACTER
Panel State.
Note: For an Update panel, first/last/notfirstorlast/only are all forms of recordAvailable. This event is ignored if the source of the event is hidden.
resetCommit
Procedure that resets the commit target actions.
Location: panel.p
Parameters: None
Notes: None
resetNavigation
Procedure that resets the navigation target actions.
Location: panel.p
Parameters: None
Notes: None
resetTableio
Procedure that encapsulates ALL tableio settings.
Location: panel.p
Parameters: None
Notes:  
Can probably replace ALL other events except:
*linkChanged(‘inactive’).
*updateState (updateComplete) and Tableiomode = update backfire of updateMode().
resetTargetActions
Procedure that resets action sensitivity and visibility.
Location: panel.p
Parameters:  
INPUT pcLink AS CHARACTER
The link type whose actions are to be reset.
Note: Overridden in toolbar.p with use of temp-tables and additional logic for alternate image.
resizeObject
Procedure that changes the size and shape of the panel. This routine spaces the buttons to fill the available space.
Location: panel.p
Parameters:  
INPUT pd_height AS DECIMAL
The desired height (in rows).
INPUT pd_width AS DECIMAL
The desired width (in columns).
Note: Used internally. Calls to resizeObject are generated by the AppBuilder in adm–create–objects for objects that implement it. Having a resizeObject procedure is also the signal to the AppBuilder to allow the object to be resized at design time.
sensitizeActions
Turns sensitivity on or off for a specified list of actions.
Location: panel.p
Parameters:  
INPUT pcActions AS CHARACTER
The comma-separated list of actions to be altered.
INPUT plSensitive AS LOGICAL
TRUE if the actions are to be made sensitive.
Returns: LOGICAL
Note: This is the static version; the dynamic version is in toolbar.p.
targetActions
Return the actions of a target.
Location: panel.p
Parameters:  
INPUT pcLinkType AS CHARACTER
The type of target.
Returns: CHARACTER
Note: This is the static version used for static buttons in panels. Overridden in toolbar.
updateState
Procedure that receives state-message events related to record updates.
Location: panel.p
Parameters:  
INPUT pcState AS CHARACTER
Update state can be Update or UpdateComplete.
Notes:  
*For Update, a Navigation Panel set its PanelState property to disable–all, to prevent navigation during an update operation. A Save or Update panel sets its state to action–chosen, meaning that a button has been pressed that puts the panel in the middle of an Update or Add or Copy operation that must be explicitly Saved to be completed.
*For UpdateComplete, a Navigation Panel restores the prior PanelState (having been disabled when the update began). A Save or Update panel sets its state to add–only if no rows are available in the current result set, to disable–all if no rows are available and there is also no available parent row for this result set (meaning that not even an Add could be done), or to initial if the RecordState is RecordAvailable, meaning that all operations are allowed (Update/Add/Copy/Delete).
*In addition, for an Update panel, which explicitly enables fields when an Update begins and disables them when the operation is Saved, the updateMode event is published with a value of UpdateEnd, to tell visualizations to disable their fields.
viewHideActions
Procedure that views and hides static actions.
Location: panel.p
Parameters:  
INPUT pcViewActions AS CHARACTER
The comma-separated list of actions to make visible.
INPUT pcHideActions AS CHARACTER
The comma-separated list of actions to make hidden.
Note: Dynamic version in toolbar.p.