Package | com.adobe.incopy |
Class | public class MarginPreference |
Inheritance | MarginPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 |
Method | Defined By | ||
---|---|---|---|
addEventListenerMarginPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | MarginPreference | ||
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
![]() | 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 [override]
Resolves the object specifier, creating an array of object references. | MarginPreference | ||
![]() | 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 | |
removeEventListenerMarginPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | MarginPreference | ||
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | MarginPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
bottom | property |
bottom:Object
Since : | CS5 |
The bottom edge of the MarginPreference.
public function get bottom():Object
public function set bottom(value:Object):void
columnCount | property |
columnCount:Number
Since : | CS5 |
The number of columns to place on the page.
public function get columnCount():Number
public function set columnCount(value:Number):void
columnDirection | property |
columnDirection:HorizontalOrVertical
Since : | CS5 |
The direction of text in the column.
public function get columnDirection():HorizontalOrVertical
public function set columnDirection(value:HorizontalOrVertical):void
columnGutter | property |
columnGutter:Object
Since : | CS5 |
The distance between columns.
public function get columnGutter():Object
public function set columnGutter(value:Object):void
columnsPositions | property |
columnsPositions:Object
Since : | CS5 |
The distance that each column guide is placed from the left margin, formatted as an array in the format [guide1, guide2, guide3].
public function get columnsPositions():Object
public function set columnsPositions(value:Object):void
customColumns | property |
customColumns:Boolean
[read-only] Since : | CS5 |
If false, columns are evenly spaced. If true, columns can have custom widths.
public function get customColumns():Boolean
eventListeners | property |
eventListeners:EventListeners
[read-only] [override] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] [override] Since : | CS5 |
A collection of events.
public function get events():Events
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
left | property |
left:Object
Since : | CS5 |
The left edge of the MarginPreference.
public function get left():Object
public function set left(value:Object):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the MarginPreference (a Application, Document or Page).
public function get parent():Object
properties | property |
properties:Object
[override] 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
right | property |
right:Object
Since : | CS5 |
The right edge of the MarginPreference.
public function get right():Object
public function set right(value:Object):void
top | property |
top:Object
Since : | CS5 |
The top edge of the MarginPreference.
public function get top():Object
public function set top(value:Object):void
addEventListenerMarginPreference | () | method |
public function addEventListenerMarginPreference(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 |
override public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerMarginPreference | () | method |
public function removeEventListenerMarginPreference(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 |
override public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |