Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
livebox:xapflash [2017/01/17 21:24]
brett
livebox:xapflash [2017/01/17 21:35] (current)
brett
Line 357: Line 357:
  
 Parent tag locations: Parent tag locations:
-  * config.xml: ''<​joggler>​ <​layout>​ <​background>''​ +  * config.xml: ''​%%<​joggler>​ <​layout>​ <​background>​%%''​ 
-  * xapconfig.xml:​ ''<​joggler>​ <​layout>​ <​background>''​ +  * xapconfig.xml:​ ''​%%<​joggler>​ <​layout>​ <​background>​%%''​ 
-  * xapconfig.xml:​ ''<​joggler>​ <​page>​ <​background>''​+  * xapconfig.xml:​ ''​%%<​joggler>​ <​page>​ <​background>​%%''​
   * xapconfig.xml:​ ''​%%<​joggler>​ <​page>​ <​textbox>​ <​background>​%%''​   * xapconfig.xml:​ ''​%%<​joggler>​ <​page>​ <​textbox>​ <​background>​%%''​
-  * config.xml: ''<​joggler>​ <​override>​ <​layout>​ <​background>''​+  * config.xml: ''​%%<​joggler>​ <​override>​ <​layout>​ <​background>​%%''​
  
 Configures a default background image that will appear on each <​page>​ unless override. ​ See [[#the '​page'​ tag]] Configures a default background image that will appear on each <​page>​ unless override. ​ See [[#the '​page'​ tag]]
Line 384: Line 384:
  
 ^ Tag ^ Key ^ Value ^ Description ^ ^ Tag ^ Key ^ Value ^ Description ^
-| <​image>​ | LP | String | The name of the image file to load as the background.\\ ​ The following file formats are accepted: JPG, PNG, GIF, BMP and SWF | +%%<​image>​%% | LP | String | The name of the image file to load as the background.\\ ​ The following file formats are accepted: JPG, PNG, GIF, BMP and SWF | 
-| <​scaleX>​ | L | Number | set the width of the background image. ​ Default: 100 | +%%<​scaleX>​%% | L | Number | set the width of the background image. ​ Default: 100 | 
-| <​scaleY>​ | L | Number | set the height of the background image. ​ Default: 100 | +%%<​scaleY>​%% | L | Number | set the height of the background image. ​ Default: 100 | 
-| <​width>​ | P | Number | set the width of the background image. ​ Default: 0 | +%%<​width>​%% | P | Number | set the width of the background image. ​ Default: 0 | 
-| <​height>​ | P | Number | set the width of the background image. ​ Default: 0 | +%%<​height>​%% | P | Number | set the width of the background image. ​ Default: 0 | 
-| <​visible>​ | PT | Boolean | Background is shown | +%%<​visible>​%% | PT | Boolean | Background is shown | 
-| <​colour>​ | PT | String | 0xRRGGBB colour specification | +%%<​colour>​%% | PT | String | 0xRRGGBB colour specification | 
-| <​posX>​ | P | Number | Horizontal pixel position for this element\\ If signed eg +20 then is relative to the default grid position of this element. | +%%<​posX>​%% | P | Number | Horizontal pixel position for this element\\ If signed eg +20 then is relative to the default grid position of this element. | 
-| <​posY>​ | P | Number | Vertical pixel position for this element\\ If signed eg -20 then is relative to the default grid position of this element. |+%%<​posY>​%% | P | Number | Vertical pixel position for this element\\ If signed eg -20 then is relative to the default grid position of this element. |
  
  
Line 408: Line 408:
 ^^ Parent tag ^^ Allowed child tags ^^ Description ^^ ^^ Parent tag ^^ Allowed child tags ^^ Description ^^
 || %%<​label>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​ <​offset>​%% || || || %%<​label>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​ <​offset>​%% || ||
-|| <​bsctext>​ || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​%% || ||+|| %%<​bsctext>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​%% || ||
 || %%<​button>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​%% || || || %%<​button>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​%% || ||
 || %%<​textBox>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​ <​align>​%% || || || %%<​textBox>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​ <​align>​%% || ||
-|| <​time>​ || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​ <​show>​%% || ||+|| %%<​time>​%% || %%<​font>​ <​fontsize>​ <​fontcolour>​ <​alpha>​ <​show>​%% || ||
 || %%<​button>​%% || %%<​style>​ <​height>​ <​width>​ <​alpha>​%% || || || %%<​button>​%% || %%<​style>​ <​height>​ <​width>​ <​alpha>​%% || ||
  
Line 446: Line 446:
 The order in which buttons are parsed, top down, is important as this determines their display precedence. ​ Buttons found later in the configuration file will display over those found before them. The order in which buttons are parsed, top down, is important as this determines their display precedence. ​ Buttons found later in the configuration file will display over those found before them.
  
-They may be placed at a grid position using ''<​gridX><​gridY>''​ or can be directly located at an absolute pixel position using ''<​posX><​posY>'';​ these are mutually exclusive if using absolute posX,posY coordinates.+They may be placed at a grid position using ''​%%<​gridX><​gridY>​%%''​ or can be directly located at an absolute pixel position using ''​%%<​posX><​posY>​%%'';​ these are mutually exclusive if using absolute posX,posY coordinates.
  
 The ''​%%<​textbox>​%%''​ object is display only and has some additional properties from a button; its content may be HTML markup for example. The ''​%%<​textbox>​%%''​ object is display only and has some additional properties from a button; its content may be HTML markup for example.
Line 490: Line 490:
  
 ^ Tag ^ Key ^ Description ^ ^ Tag ^ Key ^ Description ^
-| <​gridX>​\\ <​gridY>​ | BT | Fixes the x,y position of the element on the grid . 0,0 is top left | +%%<​gridX>​%%\\ %%<​gridY>​%% | BT | Fixes the x,y position of the element on the grid . 0,0 is top left | 
-| <​posX>​ | BT | Horizontal pixel position for this element.\\ If signed eg +20 then is relative to the default grid position of this element. | +%%<​posX>​%% | BT | Horizontal pixel position for this element.\\ If signed eg +20 then is relative to the default grid position of this element. | 
-| <​posY>​ | BT | Vertical pixel position for this element. \\ If signed eg -10 then is relative to the default grid position of this element | +%%<​posY>​%% | BT | Vertical pixel position for this element. \\ If signed eg -10 then is relative to the default grid position of this element | 
-| <​width>​ | BT | Element width either in pixels or /2 \2 x2 *3 etc\\ *2 will be double size\\ x3 will be triple size plus any gutter width additions (two widths in this case)  to ensure right hand edges align\\ /2 will be half size\\ \2 will be half size less any gutter width additions (one in this case)  to ensure right hand edges align non integer values may be used but do not right align when using \ or x | +%%<​width>​%% | BT | Element width either in pixels or /2 \2 x2 *3 etc\\ *2 will be double size\\ x3 will be triple size plus any gutter width additions (two widths in this case)  to ensure right hand edges align\\ /2 will be half size\\ \2 will be half size less any gutter width additions (one in this case)  to ensure right hand edges align non integer values may be used but do not right align when using \ or x | 
-| <​height>​ | BT | Element height either in pixels or /2 \2 x2 *3 etc as for width above |+%%<​height>​%% | BT | Element height either in pixels or /2 \2 x2 *3 etc as for width above |
 | %%<​text>​%% | BT | Default text to display. ​ Will be replaced when an associated xAP event is received. | | %%<​text>​%% | BT | Default text to display. ​ Will be replaced when an associated xAP event is received. |
-| <​textPrefix>​ | BT | If %%<​mode>​%% is text this is prepended to the xAP item. | +%%<​textPrefix>​%% | BT | If %%<​mode>​%% is text this is prepended to the xAP item. | 
-| <​textSuffix>​ | BT | If %%<​mode>​%% is text this is appended to the xAP item. | +%%<​textSuffix>​%% | BT | If %%<​mode>​%% is text this is appended to the xAP item. | 
-| %%<​html>​%% | T | boolean, default: false. ​ If defined allows full HTML inside the %%<​textPrefix>​ <​textSuffix>​%% and %%<​text>​%% tags\\ When entering html within CDATA tags the html tags do not need to be paired but must adhere to html standards\\ \\ <​textPrefix><​![CDATA[<​FONT FACE="​Times New Roman" SIZE="​36"​ COLOR="#​BB5566">​]]></​textPrefix>​\\ <​textSuffix><​![CDATA[</​FONT>​]]></​textSuffix>​\\ \\ %%<​text><​![CDATA[<​img height="​200"​ width="​200"​ src="​http://​www.bbc.co.uk/​home/​beta/​7.2/​object/​clock/​tiny.swf"></​img>​%%]]></​text>​ |+| %%<​html>​%% | T | boolean, default: false. ​ If defined allows full HTML inside the %%<​textPrefix>​ <​textSuffix>​%% and %%<​text>​%% tags\\ When entering html within CDATA tags the html tags do not need to be paired but must adhere to html standards\\ \\ %%<​textPrefix><​![CDATA[<​FONT FACE="​Times New Roman" SIZE="​36"​ COLOR="#​BB5566">​]]></​textPrefix>​%%\\ %%<​textSuffix><​![CDATA[</​FONT>​]]></​textSuffix>​%%\\ \\ %%<​text><​![CDATA[<​img height="​200"​ width="​200"​ src="​http://​www.bbc.co.uk/​home/​beta/​7.2/​object/​clock/​tiny.swf"></​img>​]]></​text>​%% |
 | %%<​font>​%% | T | The default font used for display | | %%<​font>​%% | T | The default font used for display |
-| <​fontcolour>​ | T | RGB hex triple for the colour. ​ Must be prefix with 0x. i.e. 0xDDFFAA | +%%<​fontcolour>​%% | T | RGB hex triple for the colour. ​ Must be prefix with 0x. i.e. 0xDDFFAA | 
-| <​fontsize>​ | T | Default font size of the displayed text | +%%<​fontsize>​%% | T | Default font size of the displayed text | 
-| <​multiline>​ | T | Boolean: true/false | +%%<​multiline>​%% | T | Boolean: true/false | 
-| <​wordwrap>​ | T | Boolean: true/false | +%%<​wordwrap>​%% | T | Boolean: true/false | 
-| <​hide>​ | B | text,state, default: none.  For a BSC text button (''​%%<​mode>​text</​mode>​%%''​) defines what is hidden |+%%<​hide>​%% | B | text,state, default: none.  For a BSC text button (''​%%<​mode>​text</​mode>​%%''​) defines what is hidden |
 | %%<​style>​%% | B | see [[#the '​style'​ tag]] | | %%<​style>​%% | B | see [[#the '​style'​ tag]] |
-| <​alpha>​ | BT | Amount of transparency of ALL items contained withing the UI element.\\ Floating point number: 0 transparent,​ 1 Opaque. Default 1 | +%%<​alpha>​%% | BT | Amount of transparency of ALL items contained withing the UI element.\\ Floating point number: 0 transparent,​ 1 Opaque. Default 1 | 
-| <xAP> | BT | see [[#the '​xAP'​ tag]] this is how you link a GUI object to an xAP endpoint |+%%<xAP>%% | BT | see [[#the '​xAP'​ tag]] this is how you link a GUI object to an xAP endpoint |
 | %%<​background>​%% | T | see [[#the '​background'​ section]]. | | %%<​background>​%% | T | see [[#the '​background'​ section]]. |
 | %%<​border>​%% | T | Boolean: true/​false. ​ Default: false | | %%<​border>​%% | T | Boolean: true/​false. ​ Default: false |
 | <​bordercolour>​ | T | RGB hex triple for the colour. Default 0x888888 | | <​bordercolour>​ | T | RGB hex triple for the colour. Default 0x888888 |
-| <​group>​ | B | makes a button into a radio button with '​mutually exclusive'​ style. ​ Each button in the group must be named with the same group name.  <​group>​myGroup</​group>​ |+%%<​group>​%% | B | makes a button into a radio button with '​mutually exclusive'​ style. ​ Each button in the group must be named with the same group name.  ​%%<​group>​myGroup</​group>​%% |
  
 These items require more clarification so they have been split out from the table above to allow greater explanatory detail. These items require more clarification so they have been split out from the table above to allow greater explanatory detail.
  
 ^ Tag ^ Key ^ Description ^ ^ Tag ^ Key ^ Description ^
-| <​mode>​ | BT | Determines the behaviour of the UI interface object. ​ Maybe one of the following keywords; control, lcontrol, status, secure, memory, pagetoggle, link, pageshow, pagehide, text, displaytext,​ toggle, config, xap, dimmer, slider, function |+%%<​mode>​%% | BT | Determines the behaviour of the UI interface object. ​ Maybe one of the following keywords; control, lcontrol, status, secure, memory, pagetoggle, link, pageshow, pagehide, text, displaytext,​ toggle, config, xap, dimmer, slider, function |
  
 **control**:​ A button will directly control something when pressed. ​ Only xAPBSC output endpoints can be controlled. Input endpoints such as PIR's, TEMP, CURRENTCOST obviously can'​t. ​ Sends a ''​state=toggle''​ xAPBSC.cmd to its associated endpoint. **control**:​ A button will directly control something when pressed. ​ Only xAPBSC output endpoints can be controlled. Input endpoints such as PIR's, TEMP, CURRENTCOST obviously can'​t. ​ Sends a ''​state=toggle''​ xAPBSC.cmd to its associated endpoint.
Line 528: Line 528:
 **memory**: These are status type devices that react differently when secure mode is set (see above). **memory**: These are status type devices that react differently when secure mode is set (see above).
  
-**pagetoggle**:​ This allows the button to reveal/hide a named page - either to superimpose a smaller page (often called a sub page) or to move to a totally new page.  The name of the page is supplied within a ''<​page name="">''​ tag.  Maybe deprecated in future releases please use ''<​mode>​link</​mode>''​ instead.+**pagetoggle**:​ This allows the button to reveal/hide a named page - either to superimpose a smaller page (often called a sub page) or to move to a totally new page.  The name of the page is supplied within a ''​%%<page name="">​%%''​ tag.  Maybe deprecated in future releases please use ''​%%<​mode>​link</​mode>​%%''​ instead.
  
-**link**: This allows the button to reveal/hide a named element (page, button or textbox). Often used to superimpose a smaller page (often called a sub page) or to move to a totally new page. The name of the element is supplied within an accompanying ''<​link>​...</​link>''​ tag.  See [[#the '​page'​ tag]]+**link**: This allows the button to reveal/hide a named element (page, button or textbox). Often used to superimpose a smaller page (often called a sub page) or to move to a totally new page. The name of the element is supplied within an accompanying ''​%%<​link>​...</​link>​%%''​ tag.  See [[#the '​page'​ tag]]
  
 **pageshow**:​ Reveals a named page but can't hide it again. ​ (NB will be deprecated beta 6) **pageshow**:​ Reveals a named page but can't hide it again. ​ (NB will be deprecated beta 6)
Line 559: Line 559:
 **slider**: Allows a SWF slider control to be embedded onto your page, to either control or display BSC [[http://​xapautomation.org/​index.php?​title=Basic_Status_and_Control_Schema#​Level|level=]] items. ​ Note: may also be used with BSC Stream (text=) items in a read-only capacity. ​ **slider**: Allows a SWF slider control to be embedded onto your page, to either control or display BSC [[http://​xapautomation.org/​index.php?​title=Basic_Status_and_Control_Schema#​Level|level=]] items. ​ Note: may also be used with BSC Stream (text=) items in a read-only capacity. ​
  
-Additional configuration attributes of the ''<​mode>​slider</​mode>''​ may be specified within a set of ''<​slider></​slider>''​ group tags.  The following children are allowed:+Additional configuration attributes of the ''​%%<​mode>​slider</​mode>​%%''​ may be specified within a set of ''​%%<​slider></​slider>​%%''​ group tags.  The following children are allowed:
  
 ^ Tag ^ Description ^ ^ Tag ^ Description ^
Line 913: Line 913:
 | <​alpha>​ | Alpha blending from 0.0 (transparent) to 1.0 (opaque). ​ ALL objects on the page will inherit this value. | | <​alpha>​ | Alpha blending from 0.0 (transparent) to 1.0 (opaque). ​ ALL objects on the page will inherit this value. |
 | <​visible>​ | Boolean to show or hide the element at startup. Default: true | | <​visible>​ | Boolean to show or hide the element at startup. Default: true |
-| <​group>​ | Only one member of a group can be active at once (radio group). ​ If a page in the group is made visible all others will be hidden. |+%%<​group>​%% | Only one member of a group can be active at once (radio group). ​ If a page in the group is made visible all others will be hidden. |
  
 Empty <​layout>,​ %%<​button>​%% and %%<​textbox>​%% tags have been inserted to show their relationship with respect to a <​page>​ tag. Empty <​layout>,​ %%<​button>​%% and %%<​textbox>​%% tags have been inserted to show their relationship with respect to a <​page>​ tag.