Create a Master Page for a Customized Workspace
- Last UpdatedJul 13, 2023
- 6 minute read
The SA_Include project has a Pane Genie that you can paste on a master page, allowing you to create a customized framework for a workspace.
For a description of a workspace, see Key Components of a Situational Awareness Project.
Note: Master pages need to call the function “Workspace_Init()” in their OnPageShown event.
To customize the master page for a workspace:
-
Open Graphics Builder.
-
Create a page using the "Master" template, in the resolution that will match the display client screen. Ideally, the name you give to a master page should start with “Master” to make it easy to find.
Or:
Use Save As to create a copy of a workspace master page that you would like to modify.
-
Verify that the Content Type applied to the page is "Master". See Assign a Content Type to a Page.
-
From the Graphics Builder Edit menu, select Paste Genie.
Or:
Form the Drawing Toolbox, select the Genie icon.
The Paste Genie dialog will appear.
-
In the Library field, select "sa_workspace".
-
In the Genie section, select "pane".
The Pane Genie will appear on the page.
-
Relocate and resize the pane as required.
The Pane Properties dialog will also appear when you paste the Genie on the master page.
The dialog defines setting such as:
-
The page that will display in the pane at startup
-
If autofill is enabled for the pane
-
The type of content that the pane will display
-
How the content of a pane will change as the pane is resized
-
If the pane has scroll bars.
-
-
Make the required changes to the dialog fields. For a description of the Pane Properties, see below.
-
Click OK.
Note: If you are editing an existing master page, be aware that any adjustments to a pane will mean any content designed for that pane should be resized accordingly. Not doing this will result in scaling of the content, which may not be desired. If resizing SA_Include pages, make your changes on a copy of the original pages. This will mean your changes will not be lost when the content of the SA_Include is updated in a future release.
Pane Properties
|
Property |
Description |
|---|---|
|
Name |
The name used to identify the pane. The name needs to be unique; two panes on the same page cannot have the same name. The syslog.dat file for the client will log a message if it detects duplicate panes. |
|
Default Page |
The name of the page that the pane will display at startup. If the FillMode for the pane is set to an Autofill option, this page will also display when a context change results in the pane having no content to display. |
|
Display Mode |
Determines how the content of a pane will change as the pane is resized. Use one of the following integers to specify a display mode: 1 = Stretch — the displayed page will continue to fill the pane as it changes size. 2 = Maintain aspect ratio — the displayed page will enlarge and reduce in size in proportion with the pane, however it will maintain its aspect ratio. 3 = Maintain size — the displayed page will not change in size as the pane is resized. If the page is larger than the pane it will be clipped, or scroll bars will appear if enabled. |
|
Is Default Pane? |
Set this property to TRUE if you want the pane to be the default pane within the workspace. This will make the pane the primary point of reference for the workspace. The default pane is used to display pages that have no content type defined. Each workspace can only contain one default pane. The syslog.dat file for a client will indicate if a default pane is not specified. The workspace Header Bar will refer to the page displayed in the default pane to source the active page title and breadcrumbs. This will also determine the current selection in the Navigation Zone. |
|
Display Scrollbars |
Determines if the pane will include scrollbars at runtime. FALSE = No scrollbars. TRUE = Use scrollbars. Scrollbars will only appear if the pane's DisplayMode property is set to 3 (maintain size), and the page displayed is larger than the pane. |
|
Fill Mode |
Determines how the content of a pane is updated as context changes. Use one of the following integers to specify a fill mode: Static — the content and equipment assignments within the pane remain unchanged when equipment context changes. StaticContextMustMatch — the content does not change, but any associations are updated to match the new equipment context (see below). Autofill — the pane will check the content specified for the equipment that comes into context. If it matches the pane's ContentTypes setting, the pane will display the content. If there is no valid content for the pane linked to the new equipment context, content may be sourced by traversing up/down the equipment hierarchy. AutofillContextMustMatch — The same as Autofill, however content directly associated with the new equipment context will be used to fill the pane. The content will only be updated if the equipment is a direct contextual match (see below). See Autofill for configuration examples. |
|
ContentTypes |
Defines the type of content the pane will display. You can specify zero or more types as a comma separated list. Specifying no content type is acceptable for a static pane, but it is recommended that any other type of pane has at least one content type specified. The content types you can use are configured in Visualization activity. At runtime, only pages with a content type that matches with the pane will be displayed. See Content Types. |
|
Excluded Autofill Panes |
Allows you to specify panes that will not display updated content when an equipment context change is triggered from this pane. When the context changes in the current pane, the content in the excluded panes will remain static. However, the context in excluded panes will still be updated. Any pane in the workspace or a linked workspace can be excluded. Specify the name(s) of one or more panes or nested panes that you want to exclude from autofill. Use a comma to specify more than one pane name. For more information, see Excluding Panes below. |
|
Tab Header Pane Name |
If you want the content of the pane to be controlled via a set of tabs, you can use this property to indicate the pane where the associated tab bar is located. Enter the name of the pane that hosts a page with the tab bar Genie on it. |
|
Tab Control Name |
Enter the name of the tab bar Genie that you would like to use to control the content of the pane. The tab control needs to be located on the page of the pane specified in the Tab Header Pane Name property (see above). |
|
Equipment Reference Associations: Categories |
This field allows you to associate a pane with an equipment reference category, or a comma-separated list of equipment reference categories (see "Category" in the topic Define Equipment References). When a piece of equipment comes into context, any equipment references within the specified category will be used to create Super Genie associations for a displayed page. For more information, see AssEquipReferences. |
Excluding Panes
As described above, you can use the Pane Properties dialog box to add a list of panes that you wish to exclude from autofill. Excluded panes will show the same content regardless of the context. If the current pane changes context, content in the panes specified in the Exclude Autofill Panes box will not be updated.
Note: The context within excluded panes will be updated when the context of the current page changes.
It is also possible to exclude panes at runtime by using a page environment variable. To do this:
-
Open the page that contains the context that will change.
-
Open the Page Properties dialog box.
-
Select the Environment tab.
-
Click Add. The Edit Properties dialog box is displayed.
-
In the Property box, type the property name ExcludedAutoFillPanes.
-
In the Value box, specify the name(s) of one or more panes that you want to exclude from autofill.
-
Click OK to close the Edit Properties dialog box.
-
Click OK to close the Page Properties dialog box.
Note: A pane can display a page that includes its own set of panes, creating a multi-level arrangement of nested panes. See Use Nested Panes.