com.adobe.flexbuilder.codemodel.indices
Interface ITagInformationIndex

All Superinterfaces:

IIndex, ITagInformationStore

public interface ITagInformationIndex

extends ITagInformationStore, IIndex

Index of tag information for components that are available in the project, based on the classes and components defined in the project and its class and library paths. This index also contains tag information for special tags, like XML, Script, and Style.

Field Summary

static java.lang.String

ID The tag information index ID

Method Summary

void	addListener(ITagInformationIndexListener listener) Adds a listener to this index
ITagInformationStore	getExtraTags() Get the store of extra tags that aren't represented by ActionScript classes or MXML files (like Script, Style, XML, and Model)
XMLName[]	getTagsForClass(IClass classObj) Gets the list of tags associated with the class
XMLName[]	getUnmappedTagNames(IMXMLDataProvider document) Get all of the unavailable tag names: tags whose XML namespaces (e.g.
void	removeListener(ITagInformationIndexListener listener) Removes a listener from this index

Methods inherited from interface com.adobe.flexbuilder.codemodel.indices.ITagInformationStore

getPrefixToXmlNamespaceMap, getTagInformation, getTagInformation, getTagInformation, getTagInformation, getTagNames

Methods inherited from interface com.adobe.flexbuilder.codemodel.indices.IIndex

getIndexID

Field Detail

ID

public static final java.lang.String ID

The tag information index ID

See Also:

Constant Field Values

Method Detail

getTagsForClass

public XMLName[] getTagsForClass(IClass classObj)

Gets the list of tags associated with the class

Parameters:

classObj - The ActionScript class

Returns:

The list of TagNames associated with this class

getUnmappedTagNames

public XMLName[] getUnmappedTagNames(IMXMLDataProvider document)

Get all of the unavailable tag names: tags whose XML namespaces (e.g. http://myNamespace or myPackage.*) don't already have a prefix (e.g. mx) assigned to them in the document. (Assignments happen with attributes of the form xmlns:prefix="namespace" or xmlns="namespace".)

Parameters:

document - document (for looking up prefix-to-XML namespace mappings

Returns:

array of tag names (XML namespace + short name) that aren't already mapped to a prefix in the document

addListener

public void addListener(ITagInformationIndexListener listener)

Adds a listener to this index

Parameters:

listener - The index listener

removeListener

public void removeListener(ITagInformationIndexListener listener)

Removes a listener from this index

Parameters:

listener - The index listener

getExtraTags

public ITagInformationStore getExtraTags()

Get the store of extra tags that aren't represented by ActionScript classes or MXML files (like Script, Style, XML, and Model)

Returns:

an ITagInformationIndex that allows access to these tags