SHIP:Node:page

From Serious Documentation
Jump to: navigation, search

Node Home

Node Type Description
page Visual layout area for a specific GUI "page", or "screen"

A GUI is generally composed of numerous graphically designed layout screens. Touch buttons navigate within an interactive GUI page and also cause screens to change from one to another. Since the word "screen" can easily be confused with the physical glass screen (vs. the GUI pixel content on the screen), SHIP uses the term "page" instead. The page in the GUI contains the visual layout for a specific GUI page. You can, and probably will, have many pages in a given GUI.

The names of the page nodes traditionally start with lower case "p", such as 'pHome, pSettings', etc., but this is not mandated. The name can be set to any valid name, such as homePage, or main for example.

Ancestors

The following nodes are permitted to have pages as descendants:

Node Type Description
display Contains the visual GUI layout for a specific LCD display/touch set.
layout Top of the Layout Area within a SHIP GUI, which completely describes how the GUI is visually organized.

permitted only directly underneath these nodes. permitted, but not directly, underneath these nodes.

Descendants

The following nodes are permitted within pages:

Node Type Description
box A generic rectangular container, available as a reusable resource or layout element.
constant Defines a constant value for use in SHIPTide properties or SAIL scripts.
group Lightweight node that encloses other nodes for pure organizational benefit, or to create an array of nodes.
listener Monitors one or more properties (including variable values!) for changes, and on changes invokes a script.
script Run-time algorithms, written in SHIPSail.
text Defines a text resource or a visual text representation.
timer Generates delays and timed alarm events.
variable Run-time value accessible by scripts and able to generate events on change.

only these nodes are permitted directly underneath the page node.

Properties

The following Box Model properties are available for the page node:

Box Model Outer Properties
Property Data Type Description
ot Dimension Top edge of a box model node.
ob Dimension Bottom edge of a box model node.
oh Dimension Height of a box model node.
ol Dimension Left edge of a box model node.
or Dimension Right edge of a box model node.
ow Dimension Width of a box model node.
Box Model Vertical and Horizontal Alignment Properties
Property Data Type Description
valign VALIGN Vertical alignment of a box model node within its parent container's inner dimensions.
halign HALIGN Horizontal alignment a box model node within its parent container's inner dimensions.
Box Model Margin Properties
Property Data Type Description
mt Dimension Top margin thickness of a box; not present on lightweight box model nodes such as frame and textframe.
mb Dimension Bottom margin width of a box; not present on lightweight box model nodes such as frame and textframe.
ml Dimension Left margin width of a box; not present on lightweight box model nodes such as frame and textframe
mr Dimension Right margin width of a box; not present on lightweight box model nodes such as frame and textframe
Box Model Border Properties
Property Data Type Description
bt Dimension Top border thickness of a box; not present on lightweight box model nodes such as frame and textframe.
bct Color Top border color of a box; not present on lightweight box model nodes such as frame and textframe.
bb Dimension Bottom border thickness of a box; not present on lightweight box model nodes such as frame and textframe.
bcb Color Bottom border color of a box; not present on lightweight box model nodes such as frame and textframe.
bl Dimension Left border thickness of a box; not present on lightweight box model nodes such as frame and textframe.
bcl Color Left border color of a box; not present on lightweight box model nodes such as frame and textframe.
br Dimension Right border thickness of a box; not present on lightweight box model nodes such as frame and textframe.
bcr Color Right border color of a box; not present on lightweight box model nodes such as frame and textframe.
Box Model Padding Properties
Property Data Type Description
pt Dimension Top padding thickness of a box; not present on lightweight box model nodes such as frame and textframe.
pb Dimension Bottom padding thickness of a box; not present on lightweight box model nodes such as frame and textframe.
pl Dimension Left padding thickness of a box; not present on lightweight box model nodes such as frame and textframe.
pr Dimension Right padding thickness of a box; not present on lightweight box model nodes such as frame and textframe.
Box Model Inner Dimension Properties
Property Data Type Description
it Dimension Inner area top coordinate of a box model node relative to the display.
ib Dimension Inner area bottom coordinate of a box model node relative to the display.
ih Dimension Inner area height of a box model node.
il Dimension Inner area left coordinate of a box model node relative to the display.
ir Dimension Inner area right coordinate of a box model node, relative to the display.
iw Dimension Inner area width of a box model node.
Box Model Background, Fill, Inner Color Properties
Property Data Type Description
bgcolor Color Background color of a Box Model Node, filling the container completely to the outer edges.
fillcolor Color Fill color of a box, filling the box completely within the margin area; not present on lightweight box model nodes such as frame and textframe.
innercolor Color Inner color of a box, filling the box completely within the inner area after padding is applied; not present on lightweight box model nodes such as frame and textframe.
Box Model Attached Image/Canvas Offset Properties
Property Data Type Description
xoffset Dimension The horizontal offset of an attached image or canvas within the inner area of a a Box Model Node. May be positive or negative or 0.
yoffset Dimension The vertical offset of an attached image or canvas within the inner area of a a Box Model Node. May be positive or negative or 0.


Other page Node Properties
Property Data Type Description
visible Boolean If true (default) this node will be visible iff all direct line parent nodes up to and including the display node are also visible.
opacity Byte Opacity of the displayable node and all its children, grandchildren, etc.
object Reference (optional) name of an attached object in the resources area.
over Boolean If true the touchscreen is currently pressed within the bounds of the outer area of the page.
enabled Boolean If true (default) this node and its children are able to receive events.
name** String The name used to identify this node in SHIPTide.

*available at SHIPEngine run time only and cannot be set in SHIPTide. Use a Sail script at shiplaunch time if this property needs to be set when the GUI starts to run.

**available only in SHIPTide; cannot be accessed from Sail scripts at run-time.

Examples