Packagecom.adobe.indesign
Classpublic class RuleDataObject
InheritanceRuleDataObject Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
  
addEventListenerRuleDataObject(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
RuleDataObject
 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.
RuleDataObject
 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 RuleDataObject.
RuleDataObject
  
removeEventListenerRuleDataObject(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
RuleDataObject
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
RuleDataObject
 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
dataTypeproperty
dataType:RuleDataType  [read-only]

The type of data.


Implementation
    public function get dataType():RuleDataType
dataValueproperty 
dataValue:Object

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.


Implementation
    public function get dataValue():Object
    public function set dataValue(value:Object):void
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
idproperty 
id:String  [read-only]

The ID for this rule data object.


Implementation
    public function get id():String
indexproperty 
index:Number  [read-only]

The index of the RuleDataObject 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  [read-only]

The name of the RuleDataObject.


Implementation
    public function get name():String
parentproperty 
parent:Object  [read-only]

The parent of the RuleDataObject (a PreflightProfileRule or PreflightRuleInstance).


Implementation
    public function get parent():Object
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
Method Detail
addEventListenerRuleDataObject()method
public function addEventListenerRuleDataObject(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
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 RuleDataObject.

removeEventListenerRuleDataObject()method 
public function removeEventListenerRuleDataObject(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
toSpecifier()method 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String