Package | com.adobe.incopy |
Class | public class GalleyPreference |
Inheritance | GalleyPreference ![]() ![]() ![]() |
Since : | CS5 |
Property | Defined 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 | ||
![]() | hostObjectDelegate : 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 | ||
overridePreviewFont : String
The name of the preview font. | 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 | ||
showFootnotes : Boolean
If true, displays footnotes in story and galley views. | GalleyPreference | ||
showInfoColumn : Boolean
If true, display the Info column. | GalleyPreference | ||
showLineNumbers : Boolean
If true, show line numbers. | 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 | ||
useOverridePreviewFont : Boolean
If true, uses the override preview font. | GalleyPreference |
Method | Defined By | ||
---|---|---|---|
addEventListenerGalleyPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | GalleyPreference | ||
![]() | 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. | GalleyPreference | ||
![]() | 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 | |
removeEventListenerGalleyPreference(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | GalleyPreference | ||
![]() | 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. | GalleyPreference | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
antiAliasType | property |
antiAliasType:AntiAliasType
Since : | CS5 |
The type of text anti-aliasing to use in story and galley views.
public function get antiAliasType():AntiAliasType
public function set antiAliasType(value:AntiAliasType):void
backgroundColor | property |
backgroundColor:Object
Since : | CS5 |
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.
public function get backgroundColor():Object
public function set backgroundColor(value:Object):void
blinkCursor | property |
blinkCursor:Boolean
Since : | CS5 |
If true, the cursor blinks.
public function get blinkCursor():Boolean
public function set blinkCursor(value:Boolean):void
cursorType | property |
cursorType:CursorTypes
Since : | CS5 |
The cursor type for galley and story views.
public function get cursorType():CursorTypes
public function set cursorType(value:CursorTypes):void
displayFont | property |
displayFont:String
Since : | CS5 |
Font family name to use for text display.
public function get displayFont():String
public function set displayFont(value:String):void
displayFontSize | property |
displayFontSize:Object
Since : | CS5 |
Size to use for text display.
public function get displayFontSize():Object
public function set displayFontSize(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
infoColumnWidth | property |
infoColumnWidth:Object
Since : | CS5 |
Info column width.
public function get infoColumnWidth():Object
public function set infoColumnWidth(value:Object):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
lineSpacingValue | property |
lineSpacingValue:LineSpacingType
Since : | CS5 |
Amount of spacing between lines.
public function get lineSpacingValue():LineSpacingType
public function set lineSpacingValue(value:LineSpacingType):void
overridePreviewFont | property |
overridePreviewFont:String
Since : | CS5 |
The name of the preview font.
public function get overridePreviewFont():String
public function set overridePreviewFont(value:String):void
parent | property |
parent:Object
[read-only] [override] Since : | CS5 |
The parent of the GalleyPreference (a Application or Document).
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
showDepthRuler | property |
showDepthRuler:Boolean
Since : | CS5 |
If true, displays the depth ruler.
public function get showDepthRuler():Boolean
public function set showDepthRuler(value:Boolean):void
showFootnotes | property |
showFootnotes:Boolean
Since : | CS5 |
If true, displays footnotes in story and galley views.
public function get showFootnotes():Boolean
public function set showFootnotes(value:Boolean):void
showInfoColumn | property |
showInfoColumn:Boolean
Since : | CS5 |
If true, display the Info column.
public function get showInfoColumn():Boolean
public function set showInfoColumn(value:Boolean):void
showLineNumbers | property |
showLineNumbers:Boolean
Since : | CS5 |
If true, show line numbers.
public function get showLineNumbers():Boolean
public function set showLineNumbers(value:Boolean):void
showParagraphBreakMarks | property |
showParagraphBreakMarks:Boolean
Since : | CS5 |
If true, show paragraph break marks.
public function get showParagraphBreakMarks():Boolean
public function set showParagraphBreakMarks(value:Boolean):void
showParagraphStyleNames | property |
showParagraphStyleNames:Boolean
Since : | CS5 |
If true, show paragraph style names.
public function get showParagraphStyleNames():Boolean
public function set showParagraphStyleNames(value:Boolean):void
smoothText | property |
smoothText:Boolean
Since : | CS5 |
If true, galley text is anti-aliased.
public function get smoothText():Boolean
public function set smoothText(value:Boolean):void
textColor | property |
textColor:Object
Since : | CS5 |
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.
public function get textColor():Object
public function set textColor(value:Object):void
useOverridePreviewFont | property |
useOverridePreviewFont:Boolean
Since : | CS5 |
If true, uses the override preview font.
public function get useOverridePreviewFont():Boolean
public function set useOverridePreviewFont(value:Boolean):void
addEventListenerGalleyPreference | () | method |
public function addEventListenerGalleyPreference(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 |
removeEventListenerGalleyPreference | () | method |
public function removeEventListenerGalleyPreference(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 |