Difference between revisions of "Content Page Object"

From MSX - Wiki
Jump to navigation Jump to search
 
(35 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
     "headline": "Page Headline",  
 
     "headline": "Page Headline",  
 
     "background": "http://link.to.image",
 
     "background": "http://link.to.image",
 +
    "area": "0,0,12,6",
 
     "offset": "0,0,0,0",
 
     "offset": "0,0,0,0",
 +
    "position": "page:0",
 +
    "template": null,
 
     "items": [],
 
     "items": [],
 
     "action": null,
 
     "action": null,
 
     "data": null,
 
     "data": null,
 
     "options": null,
 
     "options": null,
−
     "caption": "opt/menu"
+
     "caption": "opt/menu",
 +
    "captionUnderlay": -1
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 38: Line 42:
 
This property is part of the hidden features. For more information, please see [[Compress Property]].
 
This property is part of the hidden features. For more information, please see [[Compress Property]].
 
|-
 
|-
−
| <code>transparent</code> || <code>number</code> || <code>0</code> || No || data-sort-value=142|'''0.1.142''' ||  
+
| <code>transparent</code> || <code>number</code>{{pipe}}<code>boolean</code> || <code>0</code> || No || data-sort-value=142|'''0.1.142''' ||  
 
Indicates if the content background is transparent for this page. By default, the content background is set to a semi-transparent gray to darken the underlying video/image and make the content more visible. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page.
 
Indicates if the content background is transparent for this page. By default, the content background is set to a semi-transparent gray to darken the underlying video/image and make the content more visible. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page.
  
−
* <code>0</code>: No: The content background is not transparent.
+
* <code>0</code>{{pipe}}<code>false</code>: The content background is not transparent.
−
* <code>1</code>: Yes: The content background is transparent.
+
* <code>1</code>{{pipe}}<code>true</code>: The content background is transparent.
−
* <code>2</code>: Context related: The content background is only transparent if no video/audio is active or the active video/audio has set the extended property <code>"control:transparent"</code> to <code>"true"</code>. For more information, please see [[Extended Properties]].
+
* <code>2</code>: The content background is only transparent if no video/audio is active or the active video/audio has set the extended property <code>"control:transparent"</code> to <code>"true"</code>. For more information, please see [[Extended Properties]].
−
 
 
−
'''Note: For backwards compatibility, it is also possible to set <code>true</code> for <code>1</code> and <code>false</code> for <code>0</code>.'''
 
 
|-
 
|-
 
| <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||  
 
| <code>headline</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||  
Line 53: Line 55:
 
| <code>background</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||  
 
| <code>background</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||  
 
The background image that is used if no other background is set at lower levels. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page.
 
The background image that is used if no other background is set at lower levels. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page.
 +
|-
 +
| <code>area</code> || <code>string</code> || <code>null</code> || No || data-sort-value=156|'''0.1.156''' ||
 +
The area used by insert pages in the format <code>"x,y,w,h"</code>. This property only has an effect if the content page is set as an insert page (i.e. it is set inside the <code>inserts</code> property of the corresponding content root object). It can be used to integrate created content items into the page and specifies the area in which the items can be positioned.
 +
 +
The <code>x</code> value can go from <code>0</code> to <code>11</code> (or from <code>0</code> to <code>7</code> for panels).<br/>
 +
The <code>y</code> value can go from <code>0</code> to <code>5</code>.<br/>
 +
The <code>w</code> value can go from <code>1</code> to <code>12</code> (or from <code>1</code> to <code>8</code> for panels).<br/>
 +
The <code>h</code> value can go from <code>1</code> to <code>6</code>.<br/>
 +
 +
All values are absolute integers.
 +
 +
'''Note: To use this property, the <code>position</code> property must also be set, otherwise this property is ignored. If a template object also specifies an area, the possible <code>x</code>, <code>y</code>, <code>w</code>, and <code>h</code> values are bounded to these area values. If the created content items cannot be integrated (e.g. there is no space), the content page will be inserted without them.'''
 
|-
 
|-
 
| <code>offset</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||  
 
| <code>offset</code> || <code>string</code> || <code>null</code> || No || data-sort-value=0|0.1.0 ||  
Line 67: Line 81:
  
 
'''Note: The offset values have been increased in version 0.1.110. In previous versions, each value can only go from <code>-1.0</code> to <code>1.0</code>.'''
 
'''Note: The offset values have been increased in version 0.1.110. In previous versions, each value can only go from <code>-1.0</code> to <code>1.0</code>.'''
 +
|-
 +
| <code>position</code> || <code>string</code> || <code>null</code> || No || data-sort-value=156|'''0.1.156''' ||
 +
The desired position of an insert page in format <code>"page:{PAGE_INDEX}"</code>, <code>"offset:{INSERT_OFFSET}"</code>, or <code>"context:{CONTEXT_ID}"</code>. This property only has an effect if the content page is set as an insert page (i.e. it is set inside the <code>inserts</code> property of the corresponding content root object). If a page index is indicated, the content page is inserted once at a specific page index (e.g. <code>"page:0"</code> inserts the content page as first page, <code>"page:1"</code> inserts the content page as second page, etc.). If an insert offset is indicated, the content page is repeatedly inserted when the indicated insert offset (based on the last insertion) is reached (e.g. <code>"offset:2"</code> inserts the content page every third page). If a context ID is indicated, the content page is inserted at a specific context break (e.g. <code>"context:context_id"</code> inserts the content page if a templated content item has set the <code>break</code> property to <code>"context:context_id"</code>). It is also possible to set mulitple positions with the <code>{{pipe}}</code> separator (e.g. <code>"page:0|page:2|offset:3"</code>).
 +
 +
'''Note: It is not possible to insert multiple content pages in a row (except those ones that integrate content items with the <code>area</code> property). To check whether and which page is inserted, the following procedure is used: Check context ID → Check page index → Check insert offset. If no templated content items are available, no content pages will be inserted at all.'''
 +
|-
 +
| <code>template</code> || <code>object</code> || <code>null</code> || No || data-sort-value=156|'''0.1.156''' ||
 +
The template object used by insert pages to override specific integrated content item properties. Please see [[Content Item Object]] for the data structure. This property only has an effect if the content page is set as an insert page (i.e. it is set inside the <code>inserts</code> property of the corresponding content root object).
 +
 +
'''Note: To use this property, the <code>position</code> and <code>area</code> property must also be set, otherwise this property is ignored. It is not possible to override the <code>layout</code> or <code>break</code> property. The special inline expression <code>{context:{PROPERTY}}</code> cannot be used inside this template object.'''
 
|-
 
|-
 
| <code>items</code> || <code>array</code> || <code>null</code> || '''Yes''' || data-sort-value=0|0.1.0 ||  
 
| <code>items</code> || <code>array</code> || <code>null</code> || '''Yes''' || data-sort-value=0|0.1.0 ||  
Line 87: Line 111:
 
This property is only used if the content page is set as <code>options</code> property and can be used to set a custom options caption (indicated in the lower right corner of the content screen).
 
This property is only used if the content page is set as <code>options</code> property and can be used to set a custom options caption (indicated in the lower right corner of the content screen).
 
This property supports [[Inline Expressions]].
 
This property supports [[Inline Expressions]].
 +
|-
 +
| <code>captionUnderlay</code> || <code>number</code> || <code>-1</code> || No || data-sort-value=153|'''0.1.153''' ||
 +
The underlay of the content caption. This property can be used to explicitly set or remove the underlay of the content caption. The underlay is used to darken the lower part of the screen to make the caption more visible. By default, the underlay is used if a content list has overflowing items (i.e. content items are under the caption). This property has no effect if the content page is displayed as overlay/underlay page.
 +
 +
* <code>-1</code>: Automatically set/remove underlay.
 +
* <code>0</code>: Remove underlay.
 +
* <code>1</code>: Set underlay.
 
|}
 
|}
  

Latest revision as of 08:43, 27 March 2024

{   
    "display": true,
    "important": false,
    "wrap": false,
    "compress": true,
    "transparent": 0,
    "headline": "Page Headline", 
    "background": "http://link.to.image",
    "area": "0,0,12,6",
    "offset": "0,0,0,0",
    "position": "page:0",
    "template": null,
    "items": [],
    "action": null,
    "data": null,
    "options": null,
    "caption": "opt/menu",
    "captionUnderlay": -1
}
Property syntax of content page object
Property Type Default Value Mandatory Since Version Description
display boolean true No 0.1.0

Indicates if the content page is displayed. This property can be used to temporarily remove pages.

important boolean false No 0.1.110

Indicates if the content page is important. If this property is set to true, a corresponding overlay/underlay page is hidden if the content page is active. If the content page is displayed as overlay/underlay page and this property is set to true, the page will never be hidden.

wrap boolean false No 0.1.102

Indicates if the content page is wrapped. If this property is set to true, a corresponding menu can not be entered by using the navigation keys (i.e. left and right key). This property has no effect if the content is displayed in a panel, the content is not loaded via a menu, the content page is not the first or last one (if the content type is "pages"), or the content page is displayed as overlay/underlay page.

compress boolean true No 0.1.123

Indicates if font size adjustments are performed when the content is compressed.

Note: This property is ignored if the corresponding content root object has not set the compress property to true.

This property is part of the hidden features. For more information, please see Compress Property.

transparent number|boolean 0 No 0.1.142

Indicates if the content background is transparent for this page. By default, the content background is set to a semi-transparent gray to darken the underlying video/image and make the content more visible. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page.

  • 0|false: The content background is not transparent.
  • 1|true: The content background is transparent.
  • 2: The content background is only transparent if no video/audio is active or the active video/audio has set the extended property "control:transparent" to "true". For more information, please see Extended Properties.
headline string null No 0.1.0

The headline of the content page. This headline is attached as sub-headline to the content headline. If the content does not have a headline, this headline is used for that. This property has no effect if the content page is displayed as overlay/underlay page. This property supports Inline Expressions.

background string null No 0.1.0

The background image that is used if no other background is set at lower levels. This property has no effect if the content is displayed in a panel or the content page is displayed as overlay/underlay page.

area string null No 0.1.156

The area used by insert pages in the format "x,y,w,h". This property only has an effect if the content page is set as an insert page (i.e. it is set inside the inserts property of the corresponding content root object). It can be used to integrate created content items into the page and specifies the area in which the items can be positioned.

The x value can go from 0 to 11 (or from 0 to 7 for panels).
The y value can go from 0 to 5.
The w value can go from 1 to 12 (or from 1 to 8 for panels).
The h value can go from 1 to 6.

All values are absolute integers.

Note: To use this property, the position property must also be set, otherwise this property is ignored. If a template object also specifies an area, the possible x, y, w, and h values are bounded to these area values. If the created content items cannot be integrated (e.g. there is no space), the content page will be inserted without them.

offset string null No 0.1.0

The offset of the content page in format "x,y,w,h". This property can be used to add or subtract an offset.

Note: This property has no effect if the content type is "pages". If the content type is "list", only the y and h values are used. This property is ignored if this page is an overlay/underlay page.

The x value can go from -11.0 to 11.0 (or from -7.0 to 7.0 for panels).
The y value can go from -5.0 to 5.0.
The w value can go from -11.0 to 11.0 (or from -7.0 to 7.0 for panels).
The h value can go from -5.0 to 5.0.

All values are relative floating point numbers.

Note: The offset values have been increased in version 0.1.110. In previous versions, each value can only go from -1.0 to 1.0.

position string null No 0.1.156

The desired position of an insert page in format "page:{PAGE_INDEX}", "offset:{INSERT_OFFSET}", or "context:{CONTEXT_ID}". This property only has an effect if the content page is set as an insert page (i.e. it is set inside the inserts property of the corresponding content root object). If a page index is indicated, the content page is inserted once at a specific page index (e.g. "page:0" inserts the content page as first page, "page:1" inserts the content page as second page, etc.). If an insert offset is indicated, the content page is repeatedly inserted when the indicated insert offset (based on the last insertion) is reached (e.g. "offset:2" inserts the content page every third page). If a context ID is indicated, the content page is inserted at a specific context break (e.g. "context:context_id" inserts the content page if a templated content item has set the break property to "context:context_id"). It is also possible to set mulitple positions with the | separator (e.g. "page:0|page:2|offset:3").

Note: It is not possible to insert multiple content pages in a row (except those ones that integrate content items with the area property). To check whether and which page is inserted, the following procedure is used: Check context ID → Check page index → Check insert offset. If no templated content items are available, no content pages will be inserted at all.

template object null No 0.1.156

The template object used by insert pages to override specific integrated content item properties. Please see Content Item Object for the data structure. This property only has an effect if the content page is set as an insert page (i.e. it is set inside the inserts property of the corresponding content root object).

Note: To use this property, the position and area property must also be set, otherwise this property is ignored. It is not possible to override the layout or break property. The special inline expression {context:{PROPERTY}} cannot be used inside this template object.

items array null Yes 0.1.0

An array of content items. Please see Content Item Object for the data structure. This property is mandatory, because without it, no content items can be displayed.

action string null No 0.1.112

The content page action that is executed if the page becomes active. This property is part of the hidden features. For more information, please see Page Action.

data object null No 0.1.112

The additional data of the content page action that is used if the action is executed. This property is part of the hidden features. For more information, please see Page Action.

options object null No 0.1.120

A special page object that is displayed in a panel if a content item from this page is selected and the menu button is pressed. The availability of options for the current selected item is indicated in the lower right corner of the content screen. This property is ignored if the content is displayed in a panel. Please see Content Page Object for the data structure.

Since version 0.1.130, you can also set a Content Root Object as options.

Note: If the selected content item has its own options property, this property is ignored.

caption string "opt/menu" No 0.1.130

This property is only used if the content page is set as options property and can be used to set a custom options caption (indicated in the lower right corner of the content screen). This property supports Inline Expressions.

captionUnderlay number -1 No 0.1.153

The underlay of the content caption. This property can be used to explicitly set or remove the underlay of the content caption. The underlay is used to darken the lower part of the screen to make the caption more visible. By default, the underlay is used if a content list has overflowing items (i.e. content items are under the caption). This property has no effect if the content page is displayed as overlay/underlay page.

  • -1: Automatically set/remove underlay.
  • 0: Remove underlay.
  • 1: Set underlay.

Related Hidden Features[edit]

See also[edit]

Retrieved from "https://msx.benzac.de/wiki/index.php?title=Content_Page_Object&oldid=3434"