Packagecom.adobe.indesign
Classpublic class MarginPreference
InheritanceMarginPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  bottom : Object
The bottom edge of the MarginPreference.
MarginPreference
  columnCount : Number
The number of columns to place on the page.
MarginPreference
  columnDirection : HorizontalOrVertical
The direction of text in the column.
MarginPreference
  columnGutter : Object
The distance between columns.
MarginPreference
  columnsPositions : Object
The distance that each column guide is placed from the left margin, formatted as an array in the format [guide1, guide2, guide3].
MarginPreference
  customColumns : Boolean
[read-only] If false, columns are evenly spaced.
MarginPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
MarginPreference
  events : Events
[override] [read-only] A collection of events.
MarginPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
MarginPreference
  left : Object
The left edge of the MarginPreference.
MarginPreference
  parent : Object
[override] [read-only] The parent of the MarginPreference (a Application, Document or Page).
MarginPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
MarginPreference
  right : Object
The right edge of the MarginPreference.
MarginPreference
  top : Object
The top edge of the MarginPreference.
MarginPreference
Public Methods
 MethodDefined By
  
addEventListenerMarginPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
MarginPreference
 Inherited
addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
Preference
 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
[override] Resolves the object specifier, creating an array of object references.
MarginPreference
 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
  
removeEventListenerMarginPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
MarginPreference
 Inherited
removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
Preference
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
MarginPreference
 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
bottomproperty
bottom:Object

The bottom edge of the MarginPreference.


Implementation
    public function get bottom():Object
    public function set bottom(value:Object):void
columnCountproperty 
columnCount:Number

The number of columns to place on the page.


Implementation
    public function get columnCount():Number
    public function set columnCount(value:Number):void
columnDirectionproperty 
columnDirection:HorizontalOrVertical

The direction of text in the column.


Implementation
    public function get columnDirection():HorizontalOrVertical
    public function set columnDirection(value:HorizontalOrVertical):void
columnGutterproperty 
columnGutter:Object

The distance between columns.


Implementation
    public function get columnGutter():Object
    public function set columnGutter(value:Object):void
columnsPositionsproperty 
columnsPositions:Object

The distance that each column guide is placed from the left margin, formatted as an array in the format [guide1, guide2, guide3].


Implementation
    public function get columnsPositions():Object
    public function set columnsPositions(value:Object):void
customColumnsproperty 
customColumns:Boolean  [read-only]

If false, columns are evenly spaced. If true, columns can have custom widths.


Implementation
    public function get customColumns():Boolean
eventListenersproperty 
eventListeners:EventListeners  [read-only] [override]

A collection of event listeners.


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

A collection of events.


Implementation
    public function get events():Events
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
leftproperty 
left:Object

The left edge of the MarginPreference.


Implementation
    public function get left():Object
    public function set left(value:Object):void
parentproperty 
parent:Object  [read-only] [override]

The parent of the MarginPreference (a Application, Document or Page).


Implementation
    public function get parent():Object
propertiesproperty 
properties:Object[override]

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
rightproperty 
right:Object

The right edge of the MarginPreference.


Implementation
    public function get right():Object
    public function set right(value:Object):void
topproperty 
top:Object

The top edge of the MarginPreference.


Implementation
    public function get top():Object
    public function set top(value:Object):void
Method Detail
addEventListenerMarginPreference()method
public function addEventListenerMarginPreference(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 
override public function getElements():Object

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

Returns
Object
removeEventListenerMarginPreference()method 
public function removeEventListenerMarginPreference(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 
override public function toSpecifier():String

Retrieves the object specifier.

Returns
String