Class actuate.viewer.UIConfig
Specifies the availability of viewer features.
Member of: actuate.viewer.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Constructs a specification of feature availability for the viewer.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Indicate whether to open a new window for content when clicking a hyper link.
|
| Method Attributes | Method Name and Description |
|---|---|
|
Returns the content panel object.
|
|
|
Returns the showToc flag.
|
|
|
setContentPanel(contentPanel)
Sets the content panel for the viewer.
|
|
|
setShowToc(showToc)
Sets the showToc flag.
|
Class Detail
actuate.viewer.UIConfig()
Constructs a specification of feature availability for the viewer.
The constructor generates a new UIConfig object to manage the content panel for the viewer.
By default, the content panel is an actuate.viewer.ScrollPanel object with PanInOut, and MouseScrolling enabled.
The constructor generates a new UIConfig object to manage the content panel for the viewer.
By default, the content panel is an actuate.viewer.ScrollPanel object with PanInOut, and MouseScrolling enabled.
Field Detail
{boolean} openLinkInNewWindow
Indicate whether to open a new window for content when clicking a hyper link.
Method Detail
{actuate.viewer.BrowserPanel|actuate.viewer.ScrollPanel|null} getContentPanel()
Returns the content panel object.
For example, to retrieve and store the content panel from the viewer, use the following code:
For example, to retrieve and store the content panel from the viewer, use the following code:
var contentpanel = viewer.getUIConfig( ).getContentPanel( );
- Parameters:
- {void}
- Returns:
- {actuate.viewer.BrowserPanel|actuate.viewer.ScrollPanel|null} contentPanel The content panel setting. A null value indicates a content panel configured with the browser scroll bar enabled.
{boolean} getShowToc()
Returns the showToc flag.
For example, to determine if the showtoc flag is set to true, use the following code:
if (!viewer.getUIConfig( ).getShowToc( )){ ...}
- Parameters:
- {void}
- Returns:
- {boolean} showToc
{void} setContentPanel(contentPanel)
Sets the content panel for the viewer.
For example, to set the content panel to BrowserPanel if it is null, use the following code:
var contentpanel = viewer.getUIConfig( ).getContentPanel( );
if (contentpanel == null){
var newconfig = viewer.getUIConfig( );
newconfig.setContentPanel(new actuate.viewer.BrowserPanel( ));
viewer.setUIConfig(newconfig);
}
- Parameters:
- {Object} contentPanel
- Valid objects are actuate.viewer.BrowserPanel, actuate.viewer.ScrollPanel, and null. A null value sets a content panel configured with the browser scroll bar enabled.
- Throws:
- {actuate.viewer.ViewerException}
- if the viewer is not in interactive mode
- Returns:
- {void}
{void} setShowToc(showToc)
Sets the showToc flag.
For example, to hide the Toc in the UI, use the following code:
var newconfig = viewer.getUIConfig( ); newconfig.setShowToc(false); viewer.setUIConfig(newconfig);
- Parameters:
- {boolean} showToc
- Returns:
- {void}