Packagecom.adobe.indesign
Classpublic class GalleyPreference
InheritanceGalleyPreference Inheritance Preference Inheritance CSHostObject Inheritance flash.utils.Proxy

Preference



Public Properties
 PropertyDefined By
  antiAliasType : AntiAliasType
The type of text anti-aliasing to use in story and galley views.
GalleyPreference
  backgroundColor : Object
The background color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color.
GalleyPreference
  blinkCursor : Boolean
If true, the cursor blinks.
GalleyPreference
  cursorType : CursorTypes
The cursor type for galley and story views.
GalleyPreference
  displayFont : String
Font family name to use for text display.
GalleyPreference
  displayFontSize : Object
Size to use for text display.
GalleyPreference
  eventListeners : EventListeners
[override] [read-only] A collection of event listeners.
GalleyPreference
  events : Events
[override] [read-only] A collection of events.
GalleyPreference
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  infoColumnWidth : Object
Info column width.
GalleyPreference
  isValid : Boolean
[override] [read-only] Returns true if the object specifier resolves to valid objects.
GalleyPreference
  lineSpacingValue : LineSpacingType
Amount of spacing between lines.
GalleyPreference
  parent : Object
[override] [read-only] The parent of the GalleyPreference (a Application or Document).
GalleyPreference
  properties : Object
[override] A property that allows setting of several properties at the same time.
GalleyPreference
  showDepthRuler : Boolean
If true, displays the depth ruler.
GalleyPreference
  showInfoColumn : Boolean
If true, display the Info column.
GalleyPreference
  showParagraphBreakMarks : Boolean
If true, show paragraph break marks.
GalleyPreference
  showParagraphStyleNames : Boolean
If true, show paragraph style names.
GalleyPreference
  smoothText : Boolean
If true, galley text is anti-aliased.
GalleyPreference
  textColor : Object
The text color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color.
GalleyPreference
Public Methods
 MethodDefined By
  
addEventListenerGalleyPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
GalleyPreference
 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.
GalleyPreference
 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
  
removeEventListenerGalleyPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
GalleyPreference
 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.
GalleyPreference
 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
antiAliasTypeproperty
antiAliasType:AntiAliasType

The type of text anti-aliasing to use in story and galley views.


Implementation
    public function get antiAliasType():AntiAliasType
    public function set antiAliasType(value:AntiAliasType):void
backgroundColorproperty 
backgroundColor:Object

The background color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. . Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.


Implementation
    public function get backgroundColor():Object
    public function set backgroundColor(value:Object):void
blinkCursorproperty 
blinkCursor:Boolean

If true, the cursor blinks.


Implementation
    public function get blinkCursor():Boolean
    public function set blinkCursor(value:Boolean):void
cursorTypeproperty 
cursorType:CursorTypes

The cursor type for galley and story views.


Implementation
    public function get cursorType():CursorTypes
    public function set cursorType(value:CursorTypes):void
displayFontproperty 
displayFont:String

Font family name to use for text display.


Implementation
    public function get displayFont():String
    public function set displayFont(value:String):void
displayFontSizeproperty 
displayFontSize:Object

Size to use for text display.


Implementation
    public function get displayFontSize():Object
    public function set displayFontSize(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
infoColumnWidthproperty 
infoColumnWidth:Object

Info column width.


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

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
lineSpacingValueproperty 
lineSpacingValue:LineSpacingType

Amount of spacing between lines.


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

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


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
showDepthRulerproperty 
showDepthRuler:Boolean

If true, displays the depth ruler.


Implementation
    public function get showDepthRuler():Boolean
    public function set showDepthRuler(value:Boolean):void
showInfoColumnproperty 
showInfoColumn:Boolean

If true, display the Info column.


Implementation
    public function get showInfoColumn():Boolean
    public function set showInfoColumn(value:Boolean):void
showParagraphBreakMarksproperty 
showParagraphBreakMarks:Boolean

If true, show paragraph break marks.


Implementation
    public function get showParagraphBreakMarks():Boolean
    public function set showParagraphBreakMarks(value:Boolean):void
showParagraphStyleNamesproperty 
showParagraphStyleNames:Boolean

If true, show paragraph style names.


Implementation
    public function get showParagraphStyleNames():Boolean
    public function set showParagraphStyleNames(value:Boolean):void
smoothTextproperty 
smoothText:Boolean

If true, galley text is anti-aliased.


Implementation
    public function get smoothText():Boolean
    public function set smoothText(value:Boolean):void
textColorproperty 
textColor:Object

The text color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator.


Implementation
    public function get textColor():Object
    public function set textColor(value:Object):void
Method Detail
addEventListenerGalleyPreference()method
public function addEventListenerGalleyPreference(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
removeEventListenerGalleyPreference()method 
public function removeEventListenerGalleyPreference(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