PanelController Class Methods

In this section, the PanelController class methods are presented in alphabetical order.

Syntax

GetSide1Mode()

Description

Use the GetSide1Mode method to retrieve the current mode of the Side Page 1 panel as an Integer. Use the following integer constants of the Panel class:

  • PANEL_MODE_COLLAPSIBLE - Collapsible mode.

  • PANEL_MODE_FIXED - Fixed mode.

  • PANEL_MODE_OVERLAY - Overlay mode.

Parameters

None

Returns

An Integer value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False);

/* A simpler alternative would be &oPC.IsSide1Collapsible ... */
If &oPC.GetSide1Mode = &oPC.GetSide1Panel().PANEL_MODE_COLLAPSIBLE Then 
   ...
End-If;

Syntax

GetSide1Panel()

Description

Use the GetSide1Panel method to instantiate a Panel object representing the Side Page 1 panel with its current state.

Parameters

None

Returns

A PT_PAGE_UTILS:Panel object.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False);
Local PT_PAGE_UTILS:Panel &oSide1 = &oPC.GetSide1Panel();

Syntax

GetSide2Mode()

Description

Use the GetSide2Mode method to retrieve the current mode of the Side Page 2 panel as an Integer. Use the following integer constants of the Panel class:

  • PANEL_MODE_COLLAPSIBLE - Collapsible mode.

  • PANEL_MODE_FIXED - Fixed mode.

  • PANEL_MODE_OVERLAY - Overlay mode.

Parameters

None

Returns

An Integer value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 

/* A simpler alternative would be &oPC.IsSide2Collapsible ... */
If &oPC.GetSide2Mode = &oPC.GetSide2Panel().PANEL_MODE_COLLAPSIBLE Then 
   ...
End-If;

Syntax

GetSide2Panel()

Description

Use the GetSide2Panel method to instantiate a Panel object representing the Side Page 2 panel with its current state.

Parameters

None

Returns

A PT_PAGE_UTILS:Panel object.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False);
Local PT_PAGE_UTILS:Panel &oSide2 = &oPC.GetSide2Panel();

Syntax

Initialize(AutoUpdate)

Description

Use the Initialize method to initialize the state of the PanelController object indicating whether subsequent operations auto-update each panel (AutoUpdate = True). In addition, this method retrieves the initial settings for each panel from the server. You must invoke this method prior to any other panel controller operations. Typically, only set AutoUpdate to true when you intend to perform a single operation after invoking Initialize. When AutoUpdate is false, you must explicitly update the panels by invoking UpdatePanel.

Parameters

Field or Control

Definition
AutoUpdate

Specifies the auto-update setting as a Boolean value.

Returns

None

Example (Single Operation)

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True);   /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide1ModeFixed(); /* change mode to Fixed */

Example (Multiple Operation)

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide1ModeFixed(); /* Change mode to fixed  */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide1( True); 
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide1OpenState( True); 
&oPC.UpdatePanel(); /* Perform all updates to Side1/Side2 panels */

Syntax

IsSide1Collapsible()

Description

Use the IsSide1Collapsible method to return true if the Side Page 1 panel is set to collapsible mode.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1Collapsible() Then
   ...
End-If;

Syntax

IsSide1CollisionInterPage()

Description

Use the IsSide1CollisionInterPage method to return a boolean value indicating whether the collision that occurred was an “inter-page collision.” Inter-page collisions occur when the inner component has included the left panel as part of the page content—for example, in PeopleTools 8.54, the PSL_TWOPANEL layout page provided the mechanism for creating a left panel. In this case, the collisions occur between the Side Page 1 of the fluid wrapper and the content of the inner component.

Parameters

None.

Returns

A boolean value.

Syntax

IsSide1CollisionIntraPage()

Description

Use the IsSide1CollisionIntraPage method to return a boolean value indicating whether the collision that occurred was an “intra-page collision.” Intra-page collisions occur when the inner component has included its own left panel (that is, a page type of Side Page 1). Because the fluid wrapper also implements the left panel using Side Page 1, the collisions occur within this side page. Fluid components developed on PeopleTools 8.55 and later releases use Side Page 1 to implement the left panel.

Parameters

None.

Returns

A boolean value.

Syntax

IsSide1Enabled()

Description

Use the IsSide1Enabled method to return true if the Side Page 1 panel has been enabled by the system; otherwise, false if the system has disabled the panel.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1Enabled() Then
   ...
End-If;

Syntax

IsSide1Fixed()

Description

Use the IsSide1Fixed method to return true if the Side Page 1 panel is set to fixed mode.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False);
If &oPC.IsSide1Fixed() Then
   ...
End-If;

Syntax

IsSide1FullWidth()

Description

Use the IsSide1FullWidth method to return true if the Side Page 1 panel is set to consume the full width of the window when the panel is open.

Important! Full width mode is not recommended because the panel does not display an expand/collapse button; therefore, you must programmatically close the panel based on other user actions—such as when the user clicks a link or selects an item within the panel.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1FullWidth() Then
   ...
End-If;

Syntax

IsSide1HasCollision()

Description

Use the IsSide1HasCollision method to return a boolean value indicating whether a collision has occurred in the Side Page 1 panel and that the collision is being handled with slide-out handling.

Parameters

None.

Returns

A boolean value.

Syntax

IsSide1Hidden()

Description

Use the IsSide1Hidden method to return true if the Side Page 1 panel is hidden.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1Hidden() Then
   ...
End-If;

Syntax

IsSide1Open()

Description

Use the IsSide1Open method to return true if the Side Page 1 panel is open.

Important! Because invocations of SetSide1OpenState can have no effect in certain circumstances, this method is accurate only when the panel is set to a persistent open state.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1Open() Then
   ...
End-If;

Syntax

IsSide1Overlay()

Description

Use the IsSide1Ovelay method to return true if the Side Page 1 panel is set to overlay mode.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1Overlay() Then
   ...
End-If;

Syntax

IsSide2Collapsible()

Description

Use the IsSide2Collapsible method to return true if the Side Page 2 panel is set to collapsible mode.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide2Collapsible() Then
   ...
End-If;

Syntax

IsSide2Enabled()

Description

Use the IsSide2Enabled method to return true if the Side Page 2 panel has been enabled by the system; otherwise, false if the system has disabled the panel.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide1Enabled() Then
   ...
End-If;

Syntax

IsSide2Fixed()

Description

Use the IsSide2Fixed method to return true if the Side Page 2 panel is set to fixed mode.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide2Fixed() Then
   ...
End-If;

Syntax

IsSide2FullWidth()

Description

Use the IsSide2FullWidth method to return true if the Side Page 2 panel is set to consume the full width of the window when the panel is open.

Important! Full width mode is not recommended because the panel does not display an expand/collapse button; therefore, you must programmatically close the panel based on other user actions—such as when the user clicks a link or selects an item within the panel.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide2FullWidth() Then
   ...
End-If;

Syntax

IsSide2Hidden()

Description

Use the IsSide2Hidden method to return true if the Side Page 2 panel is hidden.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide2Hidden() Then
   ...
End-If;

Syntax

IsSide2Open()

Description

Use the IsSide2Open method to return true if the Side Page 2 panel is open.

Important! Because invocations of SetSide2OpenState can have no effect in certain circumstances, this method is accurate only when the panel is set to a persistent open state.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide2Open() Then
   ...
End-If;

Syntax

IsSide2Overlay()

Description

Use the IsSide2Ovelay method to return true if the Side Page 2 panel is set to overlay mode.

Parameters

None

Returns

A Boolean value.

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
If &oPC.IsSide2Overlay() Then
   ...
End-If;

Syntax

Refresh()

Description

Use the Refresh method to retrieve the current settings for each panel from the server.

Important! Typically, the PanelController object is declared with local scope. Only use this method to refresh the panels with current data from the server when the PanelController object has been declared with component scope to persist over multiple server trips. The Initialize method is used only within the initial PanelController object. In subsequent PeopleCode programs, use the Refresh method to retrieve the current snapshot from the system.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Component PT_PAGE_UTILS:PanelController &c_oPC; /* Initialized in another server trip - Not typically recommended */
&c_oPC.Refresh(); /* re-initializes with the latest panel data for further processing */

Syntax

SetSide1FullWidth(UseFullWidth)

Description

Use the SetSide1FullWidth method to specify a Boolean value indicating whether the Side Page 1 panel consumes the full width of the browser window when the panel is open.

Note: The default value is false.

Important! Full width mode is not recommended because the panel does not display an expand/collapse button; therefore, you must programmatically close the panel based on other user actions—such as when the user clicks a link or selects an item within the panel.

Parameters

Field or Control

Definition
UseFullWidth

Specifies a Boolean value indicating whether the panel is full width.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide1ModeOverlay(); /* change mode to overlay */
&oPC.SetSide1FullWidth( True); /* make side 1 panel consume full width of page on open */
&oPC.UpdatePanel(); /* perform all updates to Side1/Side2 panels */

Syntax

SetSide1Hidden(Hidden)

Description

Use the SetSide1Hidden method to specify a Boolean value indicating whether the Side Page 1 panel is hidden (not displayed) to users.

Note: The default value is false.

Parameters

Field or Control

Definition
Hidden

Specifies a Boolean value indicating whether the panel is hidden.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide1Hidden( True); /* do not display the side 1 panel */

Syntax

SetSide1ModeCollapsible()

Description

Use the SetSide1ModeCollapsible method to set the mode of the Side Page 1 panel to collapsible.

Note: Collapsible is the default mode for a panel.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide1ModeCollapsible(); /* change mode to collapsible mode (default) */

Syntax

SetSide1ModeFixed()

Description

Use the SetSide1ModeFixed method to set the mode of the Side Page 1 panel to fixed.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide1ModeFixed(); /* change mode to Fixed */

Syntax

SetSide1ModeOverlay()

Description

Use the SetSide1ModeOverlay method to set the mode of the Side Page 1 panel to overlay.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide1ModeOverlay(); /* change mode to always overlay mode */

Syntax

SetSide1OpenState(Open)

Description

Use the SetSide1OpenState method to set the state of the Side Page 1 panel to open when the Open parameter is true; otherwise, when Open is false, the panel state is set to closed.

Note: The state of a panel is closed by default.

Important! Whether a panel is open is a transient condition that depends on the panel's mode and prior state settings (such as, ForceOpen or PersistentOpen). Therefore, invocation of this method might be ignored.

Parameters

Field or Control

Definition
Open

Specifies a Boolean value indicating whether the panel is open.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False);  
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide1( True); 
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide1OpenState( True); 
&oPC.UpdatePanel(); /* perform all updates to Side1/Side2 panels */

Syntax

SetSide1OverrideMediaQueries(Override)

Description

Use the SetSide1OverrideMediaQueries method to specify a Boolean value indicating whether custom media queries are allowed for the Side Page 1 panel. Custom media queries allow you to set custom breakpoints for when the fixed or collapsible modes go into secondary overlay mode.

Note: The default value is false.

Parameters

Field or Control

Definition
Override

Specifies a Boolean value indicating whether custom media queries are allowed for the panel.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( False); /* Initialize for multiple operations*/
&oPC.SetSide1OverrideMediaQueries( True);
/* Bypasses Oracle-supplied media queries that convert the panel mode to secondary overlay mode for */
/* fixed or collapsible primary modes to allow media queries of your own design if desired.         */
&oPC.SetSide1ModeFixed(); /* change mode to Fixed */
&oPC.UpdatePanel(); /* perform all updates to Side1/Side2 panels */

Syntax

SetSide2FullWidth(UseFullWidth)

Description

Use the SetSide2FullWidth method to specify a Boolean value indicating whether the Side Page 2 panel consumes the full width of the browser window when the panel is open.

Note: The default value is false.

Important! Full width mode is not recommended because the panel does not display an expand/collapse button; therefore, you must programmatically close the panel based on other user actions—such as when the user clicks a link or selects an item within the panel.

Parameters

Field or Control

Definition
UseFullWidth

Specifies the a Boolean value indicating whether the panel is full width.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide2ModeOverlay(); /* change mode to overlay */
&oPC.SetSide2FullWidth( True); /* make side 1 panel consume full width of page on open */
&oPC.UpdatePanel(); /* perform all updates to Side2/Side2 panels */

Syntax

SetSide2Hidden(Hidden)

Description

Use the SetSide2Hidden method to specify a Boolean value indicating whether the Side Page 2 panel is hidden (not displayed) to users.

Note: The default value is false.

Parameters

Field or Control

Definition
Hidden

Specifies a Boolean value indicating whether the panel is hidden.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide2Hidden( True); /* do not display the side 1 panel */

Syntax

SetSide2ModeCollapsible()

Description

Use the SetSide2ModeCollapsible method to set the mode of the Side Page 2 panel to collapsible.

Note: Collapsible is the default mode for a panel.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide2ModeCollapsible(); /* change mode to collapsible mode (default) */

Syntax

SetSide2ModeFixed()

Description

Use the SetSide2ModeFixed method to set the mode of the Side Page 2 panel to fixed.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide2ModeFixed(); /* change mode to Fixed */

Syntax

SetSide2ModeOverlay()

Description

Use the SetSide2ModeOverlay method to set the mode of the Side Page 2 panel to overlay.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( True); /* Initialize for single operation – auto update so no need for UpdatePanel()*/
&oPC.SetSide2ModeOverlay(); /* change mode to always overlay mode */

Syntax

SetSide2OpenState(Open)

Description

Use the SetSide2OpenState method to set the state of the Side Page 2 panel to open when the Open parameter is true; otherwise, when Open is false, the panel state is set to closed.

Note: The state of a panel is closed by default.

Important! Whether a panel is open is a transient condition that depends on the panel's mode and prior state settings (such as, ForceOpen or PersistentOpen). Therefore, invocation of this method might be ignored.

Parameters

Field or Control

Definition
Open

Specifies a Boolean value indicating whether the panel is open.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide2ModeCollapsible(); /* Change mode to collapsible */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide2( True);
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide2OpenState( True); 
&oPC.UpdatePanel(); /* Perform all updates to Side2/Side2 panels */

Syntax

SetSide2OverrideMediaQueries(Override)

Description

Use the SetSide2OverrideMediaQueries method to specify a Boolean value indicating whether custom media queries are allowed for the Side Page 2 panel. Custom media queries allow you to set custom breakpoints for when the fixed or collapsible modes go into secondary overlay mode.

Note: The default value is false.

Parameters

Field or Control

Definition
Override

Specifies a Boolean value indicating whether custom media queries are allowed for the panel.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
&oPC.Initialize( False); /* Initialize for multiple operations*/
&oPC.SetSide2OverrideMediaQueries();
/* Bypasses Oracle-supplied media queries that convert the panel mode to secondary overlay mode for */
/* fixed or collapsible primary modes to allow media queries of your own design if desired.         */
&oPC.SetSide2ModeFixed(); /* change mode to Fixed */
&oPC.UpdatePanel(); /* perform all updates to Side2/Side2 panels */

Syntax

UpdatePanel()

Description

Use the UpdatePanel method to update the state of the panel definitions on the server with the modification made through any of the SetSiden* methods.

Note: This method is not necessary when the PanelController object is initialized with AutoUpdate set to true.

Parameters

None

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide1ModeFixed(); /* Change mode to fixed  */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide1( True);
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide1OpenState( True); 
&oPC.UpdatePanel(); /* Perform all updates to Side1/Side2 panels */

Syntax

UseForceOpenModeSide1(EnableForceMode)

Description

Use the UseForceOpenModeSide1 method to specify a Boolean value indicating whether the Side Page 1 panel can be forced to the open state when the panel is in fixed or collapsed (primary) mode or even when those modes are in secondary overlay mode. Invoke this method prior invoking a method to open the panel.

Note: The default value is false.

Parameters

Field or Control

Definition
EnableForceMode

Specifies a Boolean value indicating whether the panel can be forced to the open state.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide1ModeFixed(); /* Change mode to fixed  */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide1( True);
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide1OpenState( True); 
&oPC.UpdatePanel(); /* Perform all updates to Side1/Side2 panels */

Syntax

UseForceOpenModeSide2(EnableForceMode)

Description

Use the UseForceOpenModeSide2 method to specify a Boolean value indicating whether the Side Page 2 panel can be forced to the open state when the panel is in fixed or collapsed (primary) mode or even when those modes are in secondary overlay mode. Invoke this method prior invoking a method to open the panel.

Note: The default value is false.

Parameters

Field or Control

Definition
EnableForceMode

Specifies a Boolean value indicating whether the panel can be forced to the open state.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide2ModeFixed(); /* Change mode to fixed  */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide2( True);
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide2OpenState( True); 
&oPC.UpdatePanel(); /* Perform all updates to Side1/Side2 panels */

Syntax

UsePersistentOpenModeSide1(EnablePersistOpen)

Description

Use the UsePersistentOpenModeSide1 method to specify a Boolean value indicating whether the Side Page 1 panel is set to the persistent open state, which means that the system will not automatically close the panel after page transitions or refreshes. The panel must still be explicitly opened, after which, it must also be explicitly closed.

Note: The default value is false.

Parameters

Field or Control

Definition
EnablePersistOpen

Specifies a Boolean value indicating whether the panel is set to the persistent open state.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide1ModeFixed(); /* Change mode to fixed  */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide1( True);
/* Persist the open state over page transitions */
&oPC.UsePersistentOpenModeSide1( True); 
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide1OpenState( True); 
&oPC.UpdatePanel(); /* perform all updates to Side1/Side2 panels */

Syntax

UsePersistentOpenModeSide2(EnablePersistOpen)

Description

Use the UsePersistentOpenModeSide2 method to specify a Boolean value indicating whether the Side Page 2 panel is set to the persistent open state, which means that the system will not automatically close the panel after page transitions or refreshes. The panel must still be explicitly opened, after which, it must also be explicitly closed.

Note: The default value is false.

Parameters

Field or Control

Definition
EnablePersistOpen

Specifies a Boolean value indicating whether the panel is set to the persistent open state.

Returns

None

Example

import PT_PAGE_UTILS:*;
Local PT_PAGE_UTILS:PanelController &oPC = create PT_PAGE_UTILS:PanelController();
/* Multiple operations to be performed – auto-update disabled */
&oPC.Initialize( False); 
&oPC.SetSide2ModeFixed(); /* Change mode to fixed  */
/* Set force mode so that the panel can be forced open in fixed or collapsed */
/* primary mode as well as secondary overlay mode. */
&oPC.UseForceOpenModeSide2( True);
/* Persist the open state over page transitions */
&oPC.UsePersistentOpenModeSide2( True); 
/* Set panel open (even in secondary overlay mode) */
&oPC.SetSide2OpenState( True); 
&oPC.UpdatePanel(); /* perform all updates to Side1/Side2 panels */