org.apache.flex.compiler.tree.mxml

Interface IMXMLDesignLayerNode

All Superinterfaces:

IASNode, IMXMLClassReferenceNode, IMXMLInstanceNode, IMXMLNode, ISourceLocation

public interface IMXMLDesignLayerNode
extends IMXMLInstanceNode

This AST node represents an MXML <fx:DesignLayer> tag.

• <fx:DesignLayer> is scoped to the 2009 language namespace.
• Only id, visible and alpha are legal properties.
• visible and alpha properties can have states.
• These attributes are not supported: includeIn, excludeFrom, itemCreationPolicy, and itemDestructionPolicy.
• A DesignLayer tag without any attribute is a "no-op". It will be skipped during code generation.
• Layer children of optimized (stripped) layers will be hoisted up to parent layers if applicable.

Although <fx:DesignLayer> tag is a MXML 2009 Language tag, it does have a corresponding ActionScript class definition - mx.core.DesignLayer.

The implementation of this AST node extends IMXMLInstanceNode so that it can take advantage of the property definitions in the backing ActionScript class. However, the generated code can not treat a <fx:DesignLayer> tag as an instance of some sort of component container. Instead, all the children components under the DesignLayer tag will be hoisted to be the direct children of the DesignLayer's closest non-DesignLayer parent.

For example, given the MXML AST like the following:

 HGroup
 {
     Label l1     
     DesignLayer
     {
         Button b1
         Button b2
     }
     Label l2
 }
 

The MXML code generator will make Button "b1" and "b2" children of the HGroup, which means despite the AST shape, "b1" and "b2" will actually become siblings of "l1" and "l2" at runtime.

See Also:

Field Summary

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
int	getHoistedChildCount() Flatten <fx:DesignLayer> tags by hoisting direct children of a "DesignLayer" tag.
boolean	skipCodeGeneration() If a <fx:DesignLayer> tag has no attributes or property child nodes, it will be ignored during code generation.

Methods inherited from interface org.apache.flex.compiler.tree.mxml.IMXMLInstanceNode

getEffectiveID, getExcludeFrom, getID, getIncludeIn, getItemCreationPolicy, getItemDestructionPolicy, isEqual, resolveID

Methods inherited from interface org.apache.flex.compiler.tree.mxml.IMXMLClassReferenceNode

getClassReference, getEventSpecifierNode, getEventSpecifierNodes, getPropertySpecifierNode, getPropertySpecifierNodes, getSpecifierNodesWithSuffix, isContainer, isDeferredInstantiationUIComponent, isMXMLObject, isVisualElementContainer, needsDescriptor, needsDocumentDescriptor

Methods inherited from interface org.apache.flex.compiler.tree.mxml.IMXMLNode

getClassDefinitionNode, getDocumentNode, getFileNode, getName, isValidForCodeGen

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getNodeID, getPackageName, getParent, getSpanningStart, getSucceedingNode, isTerminal

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Method Detail

getHoistedChildCount

int getHoistedChildCount()

Flatten <fx:DesignLayer> tags by hoisting direct children of a "DesignLayer" tag. For example:

 Group
     Button #1
     DesignLayer #1
         Label #1
         Label #2
     Button #2
 

DesignLayer #1's hoisted child count is 2.

 Group
     DesignLayer #1
         Label #1
         DesignLayer #2
             Label #2
             Label #3
         Label #4
         DesignLayer #3
             HGroup
                 Label #5
 

DesignLayer #1's hoisted child count is 5. They are:

 Label #1
 Label #2
 Label #3
 Label #4
 HGroup
 

Note that Label #5 is a child of HGroup. It is not hoisted up to the Group level.

skipCodeGeneration

boolean skipCodeGeneration()

If a <fx:DesignLayer> tag has no attributes or property child nodes, it will be ignored during code generation.

Returns:

True if this <fx:DesignLayer> node will be included in the code generation.