Packagecom.adobe.indesign
Classpublic class ViewPreference
InheritanceViewPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined 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
 InheritedhostObjectDelegate : 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
Public Methods
 MethodDefined By
 Inherited
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
 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.
ViewPreference
 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
 Inherited
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
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
[override] Retrieves the object specifier.
ViewPreference
 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
cursorKeyIncrementproperty
cursorKeyIncrement:Object

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)


Implementation
    public function get cursorKeyIncrement():Object
    public function set cursorKeyIncrement(value:Object):void
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
guideSnaptoZoneproperty 
guideSnaptoZone:Number

The range (in pixels) within which an object snaps to guides. (Range: 1 to 36) Note: Snapping occurs only when guides are shown.


Implementation
    public function get guideSnaptoZone():Number
    public function set guideSnaptoZone(value:Number):void
horizontalCustomPointsproperty 
horizontalCustomPoints:Number

The distance (in points) between major tick marks on the horizontal ruler. (Range: 4 to 256) Valid only when horizontal measurement units is custom.


Implementation
    public function get horizontalCustomPoints():Number
    public function set horizontalCustomPoints(value:Number):void
horizontalMeasurementUnitsproperty 
horizontalMeasurementUnits:MeasurementUnits

The measurement unit for the horizontal ruler and other horizontally-measured spaces such as grid columns, horizontal offsets, column gutters, or others.


Implementation
    public function get horizontalMeasurementUnits():MeasurementUnits
    public function set horizontalMeasurementUnits(value:MeasurementUnits):void
isValidproperty 
isValid:Boolean  [read-only] [override]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
parentproperty 
parent:Object  [read-only] [override]

The parent of the ViewPreference (a Application or Document).


Implementation
    public function get parent():Object
pointsPerInchproperty 
pointsPerInch:Number

The number of points per inch, typically 72. (Range: 60 to 80)


Implementation
    public function get pointsPerInch():Number
    public function set pointsPerInch(value:Number):void
printDialogMeasurementUnitsproperty 
printDialogMeasurementUnits:MeasurementUnits

The measurement unit for the print dialog.


Implementation
    public function get printDialogMeasurementUnits():MeasurementUnits
    public function set printDialogMeasurementUnits(value:MeasurementUnits):void
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
rulerOriginproperty 
rulerOrigin:RulerOrigin

The default zero point at the intersection of the vertical and horizontal rulers and the scope of the horizontal ruler.


Implementation
    public function get rulerOrigin():RulerOrigin
    public function set rulerOrigin(value:RulerOrigin):void
showFrameEdgesproperty 
showFrameEdges:Boolean

If true, displays borders of unselected frames and the diagonal lines in empty unselected frames.


Implementation
    public function get showFrameEdges():Boolean
    public function set showFrameEdges(value:Boolean):void
showNotesproperty 
showNotes:Boolean

If true, notes are displayed.


Implementation
    public function get showNotes():Boolean
    public function set showNotes(value:Boolean):void
showRulersproperty 
showRulers:Boolean

If true, displays the horizontal and vertical rulers.


Implementation
    public function get showRulers():Boolean
    public function set showRulers(value:Boolean):void
strokeMeasurementUnitsproperty 
strokeMeasurementUnits:MeasurementUnits

The measurement unit for stroke measurements.


Implementation
    public function get strokeMeasurementUnits():MeasurementUnits
    public function set strokeMeasurementUnits(value:MeasurementUnits):void
textSizeMeasurementUnitsproperty 
textSizeMeasurementUnits:MeasurementUnits

The measurement unit for text size measurements.


Implementation
    public function get textSizeMeasurementUnits():MeasurementUnits
    public function set textSizeMeasurementUnits(value:MeasurementUnits):void
typographicMeasurementUnitsproperty 
typographicMeasurementUnits:MeasurementUnits

The measurement units for typography.


Implementation
    public function get typographicMeasurementUnits():MeasurementUnits
    public function set typographicMeasurementUnits(value:MeasurementUnits):void
verticalCustomPointsproperty 
verticalCustomPoints:Number

The distance (in points) between major tick marks on the vertical ruler. (Range: 4 to 256) Valid only when vertical measurement units is custom.


Implementation
    public function get verticalCustomPoints():Number
    public function set verticalCustomPoints(value:Number):void
verticalMeasurementUnitsproperty 
verticalMeasurementUnits:MeasurementUnits

The measurement unit for the vertical ruler and other vertically-measured spaces such as grid rows, vertical offsets, row heights, or others.


Implementation
    public function get verticalMeasurementUnits():MeasurementUnits
    public function set verticalMeasurementUnits(value:MeasurementUnits):void
Method Detail
addEventListenerViewPreference()method
public function addEventListenerViewPreference(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
removeEventListenerViewPreference()method 
public function removeEventListenerViewPreference(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