Layout Manager

This component dynamically resizes a Dashboard section to fit the user's current application window size.

Component Version9.5.0.0.0.3.10
Requires Hyperion Version9.5.0.0.0.0
Requires ESD Template Version9.5.0.0.0.0

Variables

TypeNameDescription
void/*Aspect framework: this is called after the onActivate() function
void/*Aspect framework: this is called before the onActivate() function
Void/*Aspect framework: this is called after the onClick function
Boolean/*Aspect framework: This is called before the onClick()function
Void/*Aspect framework: this is called after the onDeactivate function
Void/*Aspect framework: this is called before the onDeactivate function
void/*Aspect framework: this is called after the onPostProcess function
void/*Aspect framework: this is called before the onPostProcess function.
void/*Aspect framework: this is called after the onPreProcess function
void/*Aspect framework: this is called before the onPreProcess function
void/*Aspect framework: this is called after the onShutDown function
void/*Aspect framework: this is called before the onShutDown function
void/*Aspect framework: this is called after the onStartup function.
void/*Aspect framework: this is called before the onStartUp function.

Function Summary

TypeName
VoidHysl_registerControlHandler( String in_strName )
This method adds functions to the components control handler
VoidHysl_registerSectionHandler( String in_strName )
This method adds functions to the components section handlers
VoidQiq_Deactivate( Section mySection )
This function is called when an EIS section is being deactivated
VoidQiq_initLanguage( HashedArray in_har )
This function is called whenever the user switches language. Generally no action is required unless the component has its own EIS sections that do not have their "labels" refreshed as part of the OnActivate() event. Labels are the Text properties of Text Labels, drop downs, list boxes, check boxes, radio buttons and commandbuttons.
HashedArrayQiq_makeRunTime()
This function is called by the framework when an ESM is being turned into a Run-Time The function returns a hashed Array of Section references that are to be removed from the ESM to make it a run-time.
voidQiq_onActivate( Section mySection )
This function is called when a new EIS section is Activated and when Qiq_refreshEvent is called. If a component has labels with language strings, and the language has changed since this EIS was last Active, then the language strings need to be refreshed from ActiveDocument.Qiq_harConstants[<component><stringKey>]
VoidQiq_onClick( Section mySection, Control me, Control myDrp, Control myTxl, Array in_arrNames, String in_strEvent )
This function is called when an event fires for a control that belongs to this component Events can be OnClick, OnDoubleClick, OnEnter, On Exit, OnChange Control ownership by a component is determined as follows b) txlClass.Text identifies the component that handles unknown "simple names" c) <any_string>^<component_name>^<any_string> identifies a control explicitly
voidQiq_onPostProcess( Section mySection )
This function is called immediately after a Query has been processes
voidQiq_onPreProcess( Section mySection )
This function is called before a Query has been processes Pre-Brio 6.5 - this event did not exist so it is never called Brio 6.5 - causes the event that calls this function before Variable limits are applied Brio 6.6 - causes the event that calls this function after Variable limits are applied
VoidQiq_onSelection( Section mySection, Control me )
This function is called to handle the selection of an item in drpAction. The contents of drpAction had been established by the component's Qiq_onClick event. The framework uses txlMe.Text to determine which component to pass this event to
voidQiq_onShutDown()
Function is called when the document is shutting down
voidQiq_onStartUp()
This function is called when the document is starting up
StringQiq_onToolTip( Section mySection, Control me )
This function is called by the framework when the user clicks on the Tooltip icon and there is no default tooltip found for the control that is clicked. A string can be returned which is displayed as the Tooltip.
voidQiq_onWizardApply( String strStep )
This function is called when the user presses the "APPLY" button in the Wizard on one of the following steps "ASSOCIATE", "NAVIGATE", "LIMITS", "STYLES" and "PROPERTIES"
voidQiq_reset()
This function is called to reset the component's working persistent values to a pristine state This can happen when an ESM is reverting to a Template
VoidQiq_setBookMark( Section in_objSection, String in_strBookMark )
This function is called when a Checkpoint or Bookmark is requested by a user.

Detailed Function Reference

Void Hysl_registerControlHandler( String in_strName )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This method adds functions to the components control handler

Parameters
in_strName

The name of the shape whose event is to be hanled

 Void Hysl_registerSectionHandler( String in_strName )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This method adds functions to the components section handlers

Parameters
in_strName

The name of the shape whose event is to be hanled

 Void Qiq_Deactivate( Section mySection )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called when an EIS section is being deactivated

Parameters
mySection

Reference to the section being Deactivated

 Void Qiq_initLanguage( HashedArray in_har )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called whenever the user switches language. Generally no action is required unless the component has its own EIS sections that do not have their "labels" refreshed as part of the OnActivate() event. Labels are the Text properties of Text Labels, drop downs, list boxes, check boxes, radio buttons and commandbuttons.

Tooltips held in gtxlTooltip are handled automatically by the framework

Parameters
in_har

Contains the language strings, keys of the array are made up of the component name (the current section) and the Name of the Object as held in the component's gtxlLanguageStrings

 HashedArray Qiq_makeRunTime()
Defined in Orcl_layout.cbt_events_config.OnClick

This function is called by the framework when an ESM is being turned into a Run-Time The function returns a hashed Array of Section references that are to be removed from the ESM to make it a run-time.

Return value
HashedArray
void Qiq_onActivate( Section mySection )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called when a new EIS section is Activated and when Qiq_refreshEvent is called. If a component has labels with language strings, and the language has changed since this EIS was last Active, then the language strings need to be refreshed from ActiveDocument.Qiq_harConstants[<component><stringKey>]

Parameters
mySection

Refernce to the section that is being Activated

 Void Qiq_onClick( Section mySection, Control me, Control myDrp, Control myTxl, Array in_arrNames, String in_strEvent )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called when an event fires for a control that belongs to this component Events can be OnClick, OnDoubleClick, OnEnter, On Exit, OnChange Control ownership by a component is determined as follows b) txlClass.Text identifies the component that handles unknown "simple names" c) <any_string>^<component_name>^<any_string> identifies a control explicitly

Parameters
mySection

Reference to the section on which the event was caused

me

Reference to the control whose event was caused

myDrp

Reference to the drop down to be used as a helped

myTxl

Reference to the text label where the me.Name is written if myDrp is used

in_arrNames

The array of name parts for a control name split on catters (^)

in_strEvent

The event that was caused

 void Qiq_onPostProcess( Section mySection )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called immediately after a Query has been processes

Parameters
mySection

Reference to the Active Section

 void Qiq_onPreProcess( Section mySection )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called before a Query has been processes Pre-Brio 6.5 - this event did not exist so it is never called Brio 6.5 - causes the event that calls this function before Variable limits are applied Brio 6.6 - causes the event that calls this function after Variable limits are applied

Parameters
mySection

Reference to the Active Section

 Void Qiq_onSelection( Section mySection, Control me )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called to handle the selection of an item in drpAction. The contents of drpAction had been established by the component's Qiq_onClick event. The framework uses txlMe.Text to determine which component to pass this event to

Parameters
mySection

Reference to the section on which the event occured

me

Reference to the dropDown that was clicked

 void Qiq_onShutDown()
Defined in Orcl_layout.cbt_events_runTime.OnClick

Function is called when the document is shutting down

 void Qiq_onStartUp()
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called when the document is starting up

 String Qiq_onToolTip( Section mySection, Control me )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called by the framework when the user clicks on the Tooltip icon and there is no default tooltip found for the control that is clicked. A string can be returned which is displayed as the Tooltip.

Parameters
mySection

Refernce to the Active Section

me

Reference to the control that was clicked

Return value
String
void Qiq_onWizardApply( String strStep )
Defined in Orcl_layout.cbt_events_config.OnClick

This function is called when the user presses the "APPLY" button in the Wizard on one of the following steps "ASSOCIATE", "NAVIGATE", "LIMITS", "STYLES" and "PROPERTIES"

Parameters
strStep

The name of the step on which Apply was pressed

 void Qiq_reset()
Defined in Orcl_layout.cbt_events_config.OnClick

This function is called to reset the component's working persistent values to a pristine state This can happen when an ESM is reverting to a Template

 Void Qiq_setBookMark( Section in_objSection, String in_strBookMark )
Defined in Orcl_layout.cbt_events_runTime.OnClick

This function is called when a Checkpoint or Bookmark is requested by a user.

Parameters
in_objSection

A reference to the section on which the user was when they requested the checkpoint

in_strBookMark

The label assigned to identify the current Checkpoint request