asdoc/mx/managers/ILayoutManagerClient.swf.json

{ "type": "interface",
  "qname": "mx.managers.ILayoutManagerClient",
"baseInterfaceNames": [
"org.apache.royale.events.IEventDispatcher"]
,
    "description": "The ILayoutManagerClient interface defines the interface that a component must implement to participate in the LayoutManager's commit/measurement/layout sequence.  <p>Objects that implement this interface can be passed to the LayoutManager's <code>invalidateProperties()</code> method. When the LayoutManager reaches the commit properties phase, the LayoutManager invokes this object's <code>validateProperties()</code> method.</p>  <p>Similarly, if an object is passed to the LayoutManager's <code>invalidateSize()</code> method, then the LayoutManager calls that object's <code>validateSize()</code> method during its measurement phase, and if an object is passed to LayoutManager's <code>invalidateDisplayList()</code> method, then the LayoutManager  calls its <code>validateDisplayList()</code> method during the layout phase.</p>  <p>The ILayoutManagerClient interface is implemented by the UIComponent and ProgrammaticSkin classes.</p>",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Flex 3"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "initialized",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "A flag that determines if an object has been through all three phases of layout validation (provided that any were required) This flag should only be modified by the LayoutManager.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "int",
    "qname": "nestLevel",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "The top-level SystemManager has a nestLevel of 1. Its immediate children (the top-level Application and any pop-up windows) have a <code>nestLevel</code> of 2. Their children have a <code>nestLevel</code> of 3, and so on.  The <code>nestLevel</code> is used to sort ILayoutManagerClients during the measurement and layout phases. During the commit phase, the LayoutManager commits properties on clients in order of increasing <code>nestLevel</code>, so that an object's children have already had their properties committed before Flex commits properties on the object itself. During the measurement phase, the LayoutManager measures clients in order of decreasing <code>nestLevel</code>, so that an object's children have already been measured before Flex measures the object itself. During the layout phase, the LayoutManager lays out clients in order of increasing <code>nestLevel</code>, so that an object has a chance to set the sizes of its children before the child objects are asked to position and size their children.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "processedDescriptors",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "copy",
           "values": ["mx.core.UIComponent#processedDescriptors"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "accessor",
    "access": "read-write",
    "return": "Boolean",
    "qname": "updateCompletePendingFlag",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "A flag that determines if an object is waiting to have its <code>updateComplete</code> event dispatched. This flag should only be modified by the LayoutManager.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ]},
  { "type": "method",
    "qname": "validateProperties",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Validates the properties of a component. If the <code>LayoutManager.invalidateProperties()</code> method is called with this ILayoutManagerClient, then the <code>validateProperties()</code> method is called when it's time to commit property values.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ,
  { "type": "method",
    "qname": "validateSize",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Validates the measured size of the component If the <code>LayoutManager.invalidateSize()</code> method is called with this ILayoutManagerClient, then the <code>validateSize()</code> method is called when it's time to do measurements.  on the objects children.",
    "tags": [
    {  "tagName": "param",
           "values": ["recursive If <code>true</code>, call this method"]},
        {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": [{ "name": "recursive", "type": "Boolean"}]}
  ,
  { "type": "method",
    "qname": "validateDisplayList",
    "namespace": "public",
    "bindable": [],
    "details": [],
    "deprecated": {},
      "description": "Validates the position and size of children and draws other visuals. If the <code>LayoutManager.invalidateDisplayList()</code> method is called with this ILayoutManagerClient, then the <code>validateDisplayList()</code> method is called when it's time to update the display list.",
    "tags": [
    {  "tagName": "playerversion",
           "values": ["Flash 9", "AIR 1.1"]},
        {  "tagName": "productversion",
           "values": ["Flex 3"]},
        {  "tagName": "langversion",
           "values": ["3.0"]}  ],
      "return": "void",
      "params": []}
  ]
  }