Package | com.adobe.indesign |
Class | public class RuleDataObject |
Inheritance | RuleDataObject ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
dataType : RuleDataType [read-only]
The type of data. | RuleDataObject | ||
dataValue : Object
The value for this data object. | RuleDataObject | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | RuleDataObject | ||
events : Events [read-only]
A collection of events. | RuleDataObject | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : String [read-only]
The ID for this rule data object. | RuleDataObject | ||
index : Number [read-only]
The index of the RuleDataObject within its containing object. | RuleDataObject | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | RuleDataObject | ||
name : String [read-only]
The name of the RuleDataObject. | RuleDataObject | ||
parent : Object [read-only]
The parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance). | RuleDataObject | ||
properties : Object
A property that allows setting of several properties at the same time. | RuleDataObject |
Method | Defined By | ||
---|---|---|---|
addEventListenerRuleDataObject(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | RuleDataObject | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | 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. | RuleDataObject | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | 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 | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
![]() | 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 RuleDataObject. | RuleDataObject | ||
removeEventListenerRuleDataObject(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | RuleDataObject | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | RuleDataObject | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
dataType | property |
dataType:RuleDataType
[read-only] Since : | CS5 |
The type of data.
public function get dataType():RuleDataType
dataValue | property |
dataValue:Object
Since : | CS5 |
The value for this data object. Can return: String, Real, Long Integer, Short Integer, Boolean, Object or Array of Strings, Reals, Long Integers, Short Integers, Booleans, Objects or Arrays of Array of Arrays of Array of Strings, Reals, Long Integers, Short Integers, Booleans or Objects.
public function get dataValue():Object
public function set dataValue(value:Object):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
id | property |
id:String
[read-only] Since : | CS5 |
The ID for this rule data object.
public function get id():String
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the RuleDataObject within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
name | property |
name:String
[read-only] Since : | CS5 |
The name of the RuleDataObject.
public function get name():String
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance).
public function get parent():Object
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
addEventListenerRuleDataObject | () | method |
public function addEventListenerRuleDataObject(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
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)
|
EventListener |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
remove | () | method |
public function remove():void
Since : | CS5 |
Deletes the RuleDataObject.
removeEventListenerRuleDataObject | () | method |
public function removeEventListenerRuleDataObject(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
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)
|
Boolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |