Packagecom.adobe.indesign
Classpublic class CompositeFontEntry
InheritanceCompositeFontEntry Inheritance CSHostObject Inheritance flash.utils.Proxy



Public Properties
 PropertyDefined By
  appliedFont : Object
The font applied to the CompositeFontEntry, specified as either a font object or the name of font family.
CompositeFontEntry
  baselineShift : Number
The amount of baseline shift.
CompositeFontEntry
  customCharacters : String
The characters that the set affects.
CompositeFontEntry
  eventListeners : EventListeners
[read-only] A collection of event listeners.
CompositeFontEntry
  events : Events
[read-only] A collection of events.
CompositeFontEntry
  fontStyle : String
The name of the font style.
CompositeFontEntry
  horizontalScale : Number
The horizontal scaling applied to the CompositeFontEntry.
CompositeFontEntry
 InheritedhostObjectDelegate : HostObject
Getter for the delegate
CSHostObject
  id : Number
[read-only] The unique ID of the CompositeFontEntry.
CompositeFontEntry
  index : Number
[read-only] The index of the CompositeFontEntry within its containing object.
CompositeFontEntry
  isValid : Boolean
[read-only] Returns true if the object specifier resolves to valid objects.
CompositeFontEntry
  label : String
A property that can be set to any string.
CompositeFontEntry
  locked : Boolean
[read-only] If true, the CompositeFontEntry is locked.
CompositeFontEntry
  name : String
The name of the CompositeFontEntry.
CompositeFontEntry
  parent : CompositeFont
[read-only] The parent of the CompositeFontEntry (a CompositeFont).
CompositeFontEntry
  properties : Object
A property that allows setting of several properties at the same time.
CompositeFontEntry
  relativeSize : Number
The size of the entry relative to the base entry.
CompositeFontEntry
  scaleOption : Boolean
If true, scales characters from the center.
CompositeFontEntry
  verticalScale : Number
The vertical scaling applied to the CompositeFontEntry.
CompositeFontEntry
Public Methods
 MethodDefined By
  
addEventListenerCompositeFontEntry(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener.
CompositeFontEntry
  
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key.
CompositeFontEntry
 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
Resolves the object specifier, creating an array of object references.
CompositeFontEntry
 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
  
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key.
CompositeFontEntry
 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
  
remove():void
Deletes the CompositeFontEntry.
CompositeFontEntry
  
removeEventListenerCompositeFontEntry(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener.
CompositeFontEntry
 Inherited
replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call.
CSHostObject
  
toSpecifier():String
Retrieves the object specifier.
CompositeFontEntry
 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
appliedFontproperty
appliedFont:Object

The font applied to the CompositeFontEntry, specified as either a font object or the name of font family. Can return: Font or String.


Implementation
    public function get appliedFont():Object
    public function set appliedFont(value:Object):void
baselineShiftproperty 
baselineShift:Number

The amount of baseline shift.


Implementation
    public function get baselineShift():Number
    public function set baselineShift(value:Number):void
customCharactersproperty 
customCharacters:String

The characters that the set affects.


Implementation
    public function get customCharacters():String
    public function set customCharacters(value:String):void
eventListenersproperty 
eventListeners:EventListeners  [read-only]

A collection of event listeners.


Implementation
    public function get eventListeners():EventListeners
eventsproperty 
events:Events  [read-only]

A collection of events.


Implementation
    public function get events():Events
fontStyleproperty 
fontStyle:String

The name of the font style.


Implementation
    public function get fontStyle():String
    public function set fontStyle(value:String):void
horizontalScaleproperty 
horizontalScale:Number

The horizontal scaling applied to the CompositeFontEntry.


Implementation
    public function get horizontalScale():Number
    public function set horizontalScale(value:Number):void
idproperty 
id:Number  [read-only]

The unique ID of the CompositeFontEntry.


Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

The index of the CompositeFontEntry within its containing object.


Implementation
    public function get index():Number
isValidproperty 
isValid:Boolean  [read-only]

Returns true if the object specifier resolves to valid objects.


Implementation
    public function get isValid():Boolean
labelproperty 
label:String

A property that can be set to any string.


Implementation
    public function get label():String
    public function set label(value:String):void
lockedproperty 
locked:Boolean  [read-only]

If true, the CompositeFontEntry is locked.


Implementation
    public function get locked():Boolean
nameproperty 
name:String

The name of the CompositeFontEntry.


Implementation
    public function get name():String
    public function set name(value:String):void
parentproperty 
parent:CompositeFont  [read-only]

The parent of the CompositeFontEntry (a CompositeFont).


Implementation
    public function get parent():CompositeFont
propertiesproperty 
properties:Object

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
relativeSizeproperty 
relativeSize:Number

The size of the entry relative to the base entry. Note: The base entry cannot be modified.


Implementation
    public function get relativeSize():Number
    public function set relativeSize(value:Number):void
scaleOptionproperty 
scaleOption:Boolean

If true, scales characters from the center.


Implementation
    public function get scaleOption():Boolean
    public function set scaleOption(value:Boolean):void
verticalScaleproperty 
verticalScale:Number

The vertical scaling applied to the CompositeFontEntry.


Implementation
    public function get verticalScale():Number
    public function set verticalScale(value:Number):void
Method Detail
addEventListenerCompositeFontEntry()method
public function addEventListenerCompositeFontEntry(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
extractLabel()method 
public function extractLabel(keyParam:String = null):String

Gets the label value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.

Returns
String
getElements()method 
public function getElements():Object

Resolves the object specifier, creating an array of object references.

Returns
Object
insertLabel()method 
public function insertLabel(keyParam:String = null, valueParam:String = null):void

Sets the label to the value associated with the specified key.

Parameters

keyParam:String (default = null) — (String) The key.
 
valueParam:String (default = null) — (String) The value.

remove()method 
public function remove():void

Deletes the CompositeFontEntry.

removeEventListenerCompositeFontEntry()method 
public function removeEventListenerCompositeFontEntry(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 
public function toSpecifier():String

Retrieves the object specifier.

Returns
String