blob: 44e9c419d13a344f8d8ab8760b5763b9481ace4f [file] [log] [blame]
{ "type": "class",
"qname": "mx.containers.Canvas",
"baseClassname": "mx.core.Container"
,
"description": "A Halo Canvas layout container defines a rectangular region in which you place child containers and controls. It is the only container that lets you explicitly specify the location of its children within the container by using the <code>x</code> and <code>y</code> properties of each child. <p><b>Note:</b> Adobe recommends that, when possible, you use the Spark containers with BasicLayout instead of the Halo Canvas container.</p> <p>Flex sets the children of a Canvas layout container to their preferred width and preferred height. You may override the value for a child's preferred width by setting its <code>width</code> property to either a fixed pixel value or a percentage of the container size. You can set the preferred height in a similar manner.</p> <p>If you use percentage sizing inside a Canvas container, some of your components may overlap. If this is not the effect you want, plan your component positions and sizes carefully.</p> <p>The Canvas container has the following default sizing characteristics:</p> <table class=&quot;innertable&quot;> <tr> <th>Characteristic</th> <th>Description</th> </tr> <tr> <td>Default size</td> <td>Large enough to hold all its children at the default sizes of the children</td> </tr> <tr> <td>Default padding</td> <td>0 pixels for the top, bottom, left, and right values</td> </tr> </table> <p>The <code>&lt;mx:Canvas&gt;</code> tag inherits all the tag attributes of its superclass. Use the following syntax:</p> <p> <pre>\\n &lt;mx:Canvas&gt;\\n ...\\n <i>child tags</i>\\n ...\\n &lt;/mx:Canvas&gt;\\n </pre> </p>",
"tags": [
{ "tagName": "includeExample",
"values": ["examples/SimpleCanvasExample.mxml"]},
{ "tagName": "see",
"values": ["mx.core.Container"]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.containers.Canvas",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "Array",
"qname": "constraintColumns",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.containers.utilityClasses.IConstraintLayout#constraintColumns"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Array",
"qname": "constraintRows",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "copy",
"values": ["mx.containers.utilityClasses.IConstraintLayout#constraintRows"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]}]
}