Packagecom.adobe.indesign
Classpublic class XMLAttribute
InheritanceXMLAttribute Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  eventListeners : EventListeners
[read-only] A collection of event listeners.
XMLAttribute
  events : Events
[read-only] A collection of events.
XMLAttribute
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  index : Number
[read-only] The index of the XMLAttribute within its containing object.
XMLAttribute
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
XMLAttribute
  name : String
The name of the XMLAttribute.
XMLAttribute
  parent : XMLElement
[read-only] The parent of the XMLAttribute (a XMLElement).
XMLAttribute
  properties : Object
A property that allows setting of several properties at the same time.
XMLAttribute
  value : String
The value of the XMLAttribute.
XMLAttribute
Public Methods
 MethodDefined By
  
addEventListenerXMLAttribute(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
XMLAttribute
  
convertToElement(locatedParam:XMLElementLocation = null, markupTagParam:XMLTag = null):XMLElement
Converts the XML attribute to a child element of its parent element.
XMLAttribute
 Inherited
filterArgsForHBAPI(args:Array):Array
[static] Function to clean up the argument list and put it into a format that makes sense for HBAPI.
CSHostObject
 Inherited
filterSingleObjectForHBAPI(value:Object):Object
[static]
CSHostObject
 Inherited
getClassObjectForName(className:String):HostObject
[static] This returns a "Class" object, meaning, a HostObject that can be used to make static function calls or get static properties
CSHostObject
  
getElements():Object
Resolves the object specifier, creating an array of object references.
XMLAttribute
 Inherited
getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):*
[static]
CSHostObject
 Inherited
hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
CSHostObject
 Inherited
hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):*
[static] Implements a safe call of a static method on the host
CSHostObject
 Inherited
hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
CSHostObject
 Inherited
hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
CSHostObject
 Inherited
hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):*
[static] Implements a safe get of a static property on the host Used by for instance, all the enum implementations.
CSHostObject
 Inherited
hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
CSHostObject
 Inherited
hostSetStatic(className:String, propertyName:String, rawvalue:*):*
[static] Implements a safe set of a static property on the host
CSHostObject
 Inherited
isDescendedFrom(clz:Class, ancClass:Class):Boolean
[static] Efficiently determines whether or not one class descends from another in inheritance hierarchy- class relationships are cached by the ClassUtils implementation- (uses org.as3commons lib to quickly discover class hierarchy.
CSHostObject
  
remove():void
Deletes the XMLAttribute.
XMLAttribute
  
removeEventListenerXMLAttribute(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
XMLAttribute
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
select(existingSelectionParam:SelectionOptions = null):void
Selects the object.
XMLAttribute
  
toSpecifier():String
Retrieves the object specifier.
XMLAttribute
 Inherited
wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):*
[static] Method used on static/normal get/ hostcalls
CSHostObject
Protected Methods
 MethodDefined By
 Inherited
createWithArgs(args:Array):void
CSHostObject
 Inherited
hostCreate(args:Array):void
CSHostObject
Property Detail
eventListenersproperty
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
indexproperty 
index:Number  [read-only]

The index of the XMLAttribute within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
nameproperty 
name:String

The name of the XMLAttribute.


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
parent:XMLElement  [read-only]

The parent of the XMLAttribute (a XMLElement).


Implementation
    public function get parent():XMLElement
propertiesproperty 
properties:Object

A property that allows setting of several properties at the same time.


Implementation
    public function get properties():Object
    public function set properties(value:Object):void
valueproperty 
value:String

The value of the XMLAttribute.


Implementation
    public function get value():String
    public function set value(value:String):void
Method Detail
addEventListenerXMLAttribute()method
public function addEventListenerXMLAttribute(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener

Adds an event listener.

Parameters

eventTypeParam:String (default = null) — (String) The event type.
 
handlerParam:Object (default = null) — (Object) The event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
EventListener
convertToElement()method 
public function convertToElement(locatedParam:XMLElementLocation = null, markupTagParam:XMLTag = null):XMLElement

Converts the XML attribute to a child element of its parent element.

Parameters

locatedParam:XMLElementLocation (default = null) — (XMLElementLocation) The location of the new XML element within the parent XML element of the XML attribute. (Optional)
 
markupTagParam:XMLTag (default = null) — (XMLTag) The XML tag to apply to the new XML element. (Optional)

Returns
XMLElement
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
remove()method 
public function remove():void

Deletes the XMLAttribute.

removeEventListenerXMLAttribute()method 
public function removeEventListenerXMLAttribute(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean

Removes the event listener.

Parameters

eventTypeParam:String (default = null) — (String) The registered event type.
 
handlerParam:Object (default = null) — (Object) The registered event handler. Can accept: File or JavaScript Function.
 
capturesParam:Boolean (default = false) — (Boolean) This parameter is obsolete. (Optional)

Returns
Boolean
select()method 
public function select(existingSelectionParam:SelectionOptions = null):void

Selects the object.

Parameters

existingSelectionParam:SelectionOptions (default = null) — (SelectionOptions) The selection status of the XMLAttribute in relation to previously selected objects. (Optional)

toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String