Package | com.adobe.incopy |
Class | public class ViewPreference |
Inheritance | ViewPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
cursorKeyIncrement : Object
The distance to move a specified object when an arrow key is pressed. | ViewPreference | ||
eventListeners : EventListeners [override] [read-only]
A collection of event listeners. | ViewPreference | ||
events : Events [override] [read-only]
A collection of events. | ViewPreference | ||
guideSnaptoZone : Number
The range (in pixels) within which an object snaps to guides. | ViewPreference | ||
horizontalCustomPoints : Number
The distance (in points) between major tick marks on the horizontal ruler. | ViewPreference | ||
horizontalMeasurementUnits : MeasurementUnits
The measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others. | ViewPreference | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
isValid : Boolean [override] [read-only]
Returns true if the object specifier resolves to valid objects. | ViewPreference | ||
parent : Object [override] [read-only]
The parent of the ViewPreference (a Application or Document). | ViewPreference | ||
pointsPerInch : Number
The number of points per inch, typically 72. | ViewPreference | ||
printDialogMeasurementUnits : MeasurementUnits
The measurement unit for the print dialog. | ViewPreference | ||
properties : Object [override]
A property that allows setting of several properties at the same time. | ViewPreference | ||
rulerOrigin : RulerOrigin
The default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler. | ViewPreference | ||
showFrameEdges : Boolean
If true, displays borders of unselected frames and the diagonal lines in empty unselected frames. | ViewPreference | ||
showNotes : Boolean
If true, notes are displayed. | ViewPreference | ||
showRulers : Boolean
If true, displays the horizontal and vertical rulers. | ViewPreference | ||
strokeMeasurementUnits : MeasurementUnits
The measurement unit for stroke measurements. | ViewPreference | ||
textSizeMeasurementUnits : MeasurementUnits
The measurement unit for text size measurements. | ViewPreference | ||
typographicMeasurementUnits : MeasurementUnits
The measurement units for typography. | ViewPreference | ||
verticalCustomPoints : Number
The distance (in points) between major tick marks on the vertical ruler. | ViewPreference | ||
verticalMeasurementUnits : MeasurementUnits
The measurement unit for the vertical ruler and other vertically-measured spaces such as grid rows, vertical offsets, row heights, or others. | ViewPreference |
Method | Defined By | ||
---|---|---|---|
![]() | addEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Preference | |
addEventListenerViewPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | ViewPreference | ||
![]() | 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. | ViewPreference | ||
![]() | 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 | |
![]() | removeEventListenerPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Preference | |
removeEventListenerViewPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | ViewPreference | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String [override]
Retrieves the object specifier. | ViewPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
cursorKeyIncrement | property |
cursorKeyIncrement:Object
Since : | CS5 |
The distance to move a specified object when an arrow key is pressed. (Range depends on the measurement unit. For points: 0.001 to 100; picas: 0p0.001 to 8p4; mm: 0 to 35.278; cm: 0 to 3.5278; inches: 0 to 1.3889; ciceros: 0c0.001 to 7c9.839)
public function get cursorKeyIncrement():Object
public function set cursorKeyIncrement(value:Object):void
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
guideSnaptoZone | property |
guideSnaptoZone:Number
Since : | CS5 |
The range (in pixels) within which an object snaps to guides. (Range: 1 to 36) Note: Snapping occurs only when guides are shown.
public function get guideSnaptoZone():Number
public function set guideSnaptoZone(value:Number):void
horizontalCustomPoints | property |
horizontalCustomPoints:Number
Since : | CS5 |
The distance (in points) between major tick marks on the horizontal ruler. (Range: 4 to 256) Valid only when horizontal measurement units is custom.
public function get horizontalCustomPoints():Number
public function set horizontalCustomPoints(value:Number):void
horizontalMeasurementUnits | property |
horizontalMeasurementUnits:MeasurementUnits
Since : | CS5 |
The measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others.
public function get horizontalMeasurementUnits():MeasurementUnits
public function set horizontalMeasurementUnits(value:MeasurementUnits):void
isValid | property |
isValid:Boolean
[read-only] [override] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the ViewPreference (a Application or Document).
public function get parent():Object
pointsPerInch | property |
pointsPerInch:Number
Since : | CS5 |
The number of points per inch, typically 72. (Range: 60 to 80)
public function get pointsPerInch():Number
public function set pointsPerInch(value:Number):void
printDialogMeasurementUnits | property |
printDialogMeasurementUnits:MeasurementUnits
Since : | CS5 |
The measurement unit for the print dialog.
public function get printDialogMeasurementUnits():MeasurementUnits
public function set printDialogMeasurementUnits(value:MeasurementUnits):void
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
rulerOrigin | property |
rulerOrigin:RulerOrigin
Since : | CS5 |
The default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler.
public function get rulerOrigin():RulerOrigin
public function set rulerOrigin(value:RulerOrigin):void
showFrameEdges | property |
showFrameEdges:Boolean
Since : | CS5 |
If true, displays borders of unselected frames and the diagonal lines in empty unselected frames.
public function get showFrameEdges():Boolean
public function set showFrameEdges(value:Boolean):void
showNotes | property |
showNotes:Boolean
Since : | CS5 |
If true, notes are displayed.
public function get showNotes():Boolean
public function set showNotes(value:Boolean):void
showRulers | property |
showRulers:Boolean
Since : | CS5 |
If true, displays the horizontal and vertical rulers.
public function get showRulers():Boolean
public function set showRulers(value:Boolean):void
strokeMeasurementUnits | property |
strokeMeasurementUnits:MeasurementUnits
Since : | CS5 |
The measurement unit for stroke measurements.
public function get strokeMeasurementUnits():MeasurementUnits
public function set strokeMeasurementUnits(value:MeasurementUnits):void
textSizeMeasurementUnits | property |
textSizeMeasurementUnits:MeasurementUnits
Since : | CS5 |
The measurement unit for text size measurements.
public function get textSizeMeasurementUnits():MeasurementUnits
public function set textSizeMeasurementUnits(value:MeasurementUnits):void
typographicMeasurementUnits | property |
typographicMeasurementUnits:MeasurementUnits
Since : | CS5 |
The measurement units for typography.
public function get typographicMeasurementUnits():MeasurementUnits
public function set typographicMeasurementUnits(value:MeasurementUnits):void
verticalCustomPoints | property |
verticalCustomPoints:Number
Since : | CS5 |
The distance (in points) between major tick marks on the vertical ruler. (Range: 4 to 256) Valid only when vertical measurement units is custom.
public function get verticalCustomPoints():Number
public function set verticalCustomPoints(value:Number):void
verticalMeasurementUnits | property |
verticalMeasurementUnits:MeasurementUnits
Since : | CS5 |
The measurement unit for the vertical ruler and other vertically-measured spaces such as grid rows, vertical offsets, row heights, or others.
public function get verticalMeasurementUnits():MeasurementUnits
public function set verticalMeasurementUnits(value:MeasurementUnits):void
addEventListenerViewPreference | () | method |
public function addEventListenerViewPreference(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 |
removeEventListenerViewPreference | () | method |
public function removeEventListenerViewPreference(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 |