Difference between revisions of "SHIP:Property:layoutarea:enabled"

From Serious Documentation
Jump to: navigation, search
(Created page with "=== Node: {{Node|layoutarea|Layout Area Nodes}} === {| class="wikitable" style="margin: 1em auto 1em auto;" ! scope="col" | Property ! scope="col" | Data Type ! scope="col" |...")
 
 
Line 1: Line 1:
 
=== Node: {{Node|layoutarea|Layout Area Nodes}} ===
 
=== Node: {{Node|layoutarea|Layout Area Nodes}} ===
{| class="wikitable" style="margin: 1em auto 1em auto;"
+
{{PropTableStart}}
! scope="col" | Property
 
! scope="col" | Data Type
 
! scope="col" | Description
 
 
|-
 
|-
 
|<onlyinclude>{{Prop|layoutarea|enabled}}||{{DataType|Boolean}}|| If {{Reserved|true}} (default) this node and its children are able to receive events.</onlyinclude>
 
|<onlyinclude>{{Prop|layoutarea|enabled}}||{{DataType|Boolean}}|| If {{Reserved|true}} (default) this node and its children are able to receive events.</onlyinclude>
Line 9: Line 6:
 
All {{Node|listener}} nodes within a node (i.e. children, grandchildren, etc.) will be blocked from receiving events when this property is {{Reserved|false}}.
 
All {{Node|listener}} nodes within a node (i.e. children, grandchildren, etc.) will be blocked from receiving events when this property is {{Reserved|false}}.
  
For example, a touch {{Node|listener}} in a {{Node|box}} where the {{Node|box}}'s {{Prop|box|enabled}} property is {{Reserved|false}} will prevent the {{Node|listener}} from waking on touch events.
+
For example, a touch {{Node|listener}} in a {{Node|box}} where the {{Node|box}}'s {{Prop|layoutarea|enabled}} property is {{Reserved|false}} will prevent the {{Node|listener}} from waking on touch events.
  
 
The only exception to this behavior is the {{Node|timer}} node; the {{Node|timer}}'s {{Prop|timer|enabled}} property starts/stops the timer and does '''not''' affect the {{Node|listener}}s within it.
 
The only exception to this behavior is the {{Node|timer}} node; the {{Node|timer}}'s {{Prop|timer|enabled}} property starts/stops the timer and does '''not''' affect the {{Node|listener}}s within it.

Latest revision as of 12:21, 31 January 2013

Node: Layout Area Nodes

{{{1}}}
Property Data Type Description
enabled Boolean If true (default) this node and its children are able to receive events.

All listener nodes within a node (i.e. children, grandchildren, etc.) will be blocked from receiving events when this property is false.

For example, a touch listener in a box where the box's enabled property is false will prevent the listener from waking on touch events.

The only exception to this behavior is the timer node; the timer's enabled property starts/stops the timer and does not affect the listeners within it.