Promotic
WikipediaLinkedInYoutubeTwitterFacebook

Frames - page of object PmWorkspace

Description:
Workspace frames layout definition. Workspace is the main window with its client area represented by root frame with MainFrame identifer. The root frame size is determined by the size of the workspace window. Each frame (including the root frame) can be divided in this page into arbitrary number of subframes in both horisontal and vertical directions. Each subframe can be continuously divided into smaller subframes. This way the hierarchic frame structure si being created, where each frame has its parents (except for the root frame) and may contain multiple subframes on many levels. This hierarchic frame structure can be edited with the configurator.
Configuration items:
List of framesHierarchical list of frames that can be edited.
Buttons:
NewOpens the configurator that can be used for adding a new frame into the hierarchic level.
EditOpens the configurator that can be used for editing the selected frame.
DeleteRemoves the marked frame
Up/DownIt is possible to change the order of frames. By pressing the Up/Down button the marked item will be moved upward/downword in the list. The same effect can be achieved by pressing the key combination ALT+up key/down key.
Configuration items:
IdentifierFrame text identifier. This identifier must be unique in the PmWorkspace object. Other methods and configurators are referring to this frame using this identifier (see for example the value "target" in the sOptions parameter of the OpenView methods).

This identifier must not contain values "blank" and "self" and must not begin with the "underscore" character.

This is a system name and must not contain empty string, diacritics, spaces and the first character must not be a number or underscore.

Frame typeFrame type based on contained subframes point of view.
Simple - no subframes - The component viewers will be displayed only in this frame.
Horizontal - subframes placed horizontally (side-by-side)) - This frame is used for definition of subframes placed horizontally.
Vertical - subframes placed vertically (next one under previous) - This frame is used for definition of subframes placed vertically.
Frame sizeSize of frame. Can be specified relatively (* or in percentage) or absolutely (in pixels).
Npx or N - Absolute frame size (in pixels). For example 50px or 50.
N% - Relative frame size defined in percentage of the parent frame size. For example 25%.
* - (asterisk) Complete accessible remainder (or its proportional part, if there is more of such frames). The sizes of other frames are subtracted from the size of parent frame. Remaining size is devided to all frames of the same level which requested remaining size.
Minimum width (px)Minimum frame width (in pixels).

Not used if the "Frame size" configurator is set as absolute value (in pixels).

If not set then it is possible to decrease the size of the frame down to zero.

 
The minimum size can be defined in each individual frame, but it can also be set in root frame (in main frame identified as MainFrame).
 
Setting the minimum size ("Minimum width" or "Minimum height") is important, for example, when the workspace is enabled to WEB and displayed on small displays of handheld devices (Android smartphones...). In such case the workspace is displayed very small (so it fits the small display), cannot be zoomed and is dificult to scroll. For these cases it is recommended to define minimum size as the displays of supposed devices would be (e.g. based on configurators Panel width / Panel height of displayed PmPanel object).
Minimum height (px)Minimum frame height (in pixels).

Not used if the "Frame size" configurator is set as absolute value (in pixels).

If not set then it is possible to decrease the size of the frame down to zero.

Border type Defines the method of frame outline highlighting, in order to help distinguish neighbor frames. The dimension of the frame area used for rendering the brobser view is decreased by the outline width. Relevant only for Simple type frames used for browser views.
None - no border - The frame has no highlighted outline and no optical differentiation element to distinguish neighbor frames.
Inset - inset efect - The frame has outlines creating effect of frame being immersed into surrounding area. The outline width is 2 pixels.
Viewer of componentThe path to the object, representing component viewer (path to PmPanel, PmReport, PmAlarmEvent, ...), that will be present in this frame after opening the workspace for the first time. Changing the viewer in this frame can be done by the OpenView methods.

Relevant only for Simple type frames used for browser views.

Params default valueAdditional parameters for opening component viewer. Similar parameter is sParams in OpenView methods. For example, PmPanel object with graphic item parameters (e.g. "par:boiler=5;")
- Relevant only for Simple type frames used for browser views.
- The text stated in this configurator is entered without the quaotation marks (the " char is not used at start and at end).
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice