com.adobe.flexbuilder.codemodel.indices
Interface IVisibleComponentIndex

All Superinterfaces:
IIndex

public interface IVisibleComponentIndex
extends IIndex

Index of visible components (ones that derive from UIComponent) defined in the project and its class and library paths.


Field Summary
static java.lang.String ID
          The component index ID
 
Method Summary
 void addListener(IVisibleComponentIndexListener listener)
          Adds a listener to this index
 IClass[] getComponentClasses()
          Returns all of the components in the index
 XMLName[] getComponentTagNames()
          Returns an array of all of the component tag names.
 void removeListener(IVisibleComponentIndexListener listener)
          Removes a listener from this index
 
Methods inherited from interface com.adobe.flexbuilder.codemodel.indices.IIndex
getIndexID
 

Field Detail

ID

public static final java.lang.String ID
The component index ID

See Also:
Constant Field Values
Method Detail

addListener

public void addListener(IVisibleComponentIndexListener listener)
Adds a listener to this index

Parameters:
listener - The index listener

removeListener

public void removeListener(IVisibleComponentIndexListener listener)
Removes a listener from this index

Parameters:
listener - The index listener

getComponentClasses

public IClass[] getComponentClasses()
Returns all of the components in the index

Returns:
All of the components in the index

getComponentTagNames

public XMLName[] getComponentTagNames()
Returns an array of all of the component tag names. This will only include one XML name per class. If a class is in a namespace manifest, we'll include the XML name based on that namespace manifest and skip the one based on its package. If a class is in multiple namespace manifests, we'll just pick one.

Returns:
all of the component tag names