Package | com.adobe.incopy |
Class | public class Font |
Inheritance | Font ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
allowEditableEmbedding : Boolean [read-only]
If true, the font can be embedded. | Font | ||
allowOutlines : Boolean [read-only]
If true, the font can be converted to outlines. | Font | ||
allowPDFEmbedding : Boolean [read-only]
If true, the font can be embedded in a PDF document. | Font | ||
allowPrinting : Boolean [read-only]
If true, the can font be printed. | Font | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Font | ||
events : Events [read-only]
A collection of events. | Font | ||
fontFamily : String [read-only]
The name of the font family
| Font | ||
fontStyleName : String [read-only]
The name of the font style. | Font | ||
fontStyleNameNative : String [read-only]
The native name of the font style. | Font | ||
fontType : FontTypes [read-only]
The type of font. | Font | ||
fullName : String [read-only]
The full font name. | Font | ||
fullNameNative : String [read-only]
The full native name of the font. | Font | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
index : Number [read-only]
The index of the Font within its containing object. | Font | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Font | ||
location : String [read-only]
The full path to the Font. | Font | ||
name : String [read-only]
The name of the Font. | Font | ||
ordering : String [read-only]
The ordering of a CID font. | Font | ||
parent : Object [read-only]
The parent of the Font (a Document or Application). | Font | ||
platformName : String [read-only]
The platform font name. | Font | ||
postscriptName : String [read-only]
The PostScript name of the font. | Font | ||
properties : Object
A property that allows setting of several properties at the same time. | Font | ||
registry : String [read-only]
The registry of a CID font. | Font | ||
restrictedPrinting : Boolean [read-only]
If true, the font allows only restricted printing. | Font | ||
status : FontStatus [read-only]
The status of the font. | Font | ||
version : String [read-only]
The font version. | Font | ||
writingScript : Number [read-only]
The writing script. | Font |
Method | Defined By | ||
---|---|---|---|
addEventListenerFont(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Font | ||
checkOpenTypeFeature(usingParam:Object = null):Boolean
Checks whether the font supports the specified OpenType feature. | Font | ||
createSubsetFont(charactersForSubsetParam:String = null, fontDestinationParam:File = null):void
Create a copy of the font with just enough information to render the list of characters given. | Font | ||
![]() | 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
Resolves the object specifier, creating an array of object references. | Font | ||
![]() | 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 | |
removeEventListenerFont(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Font | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | Font | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
allowEditableEmbedding | property |
allowEditableEmbedding:Boolean
[read-only] Since : | CS5 |
If true, the font can be embedded.
public function get allowEditableEmbedding():Boolean
allowOutlines | property |
allowOutlines:Boolean
[read-only] Since : | CS5 |
If true, the font can be converted to outlines.
public function get allowOutlines():Boolean
allowPDFEmbedding | property |
allowPDFEmbedding:Boolean
[read-only] Since : | CS5 |
If true, the font can be embedded in a PDF document.
public function get allowPDFEmbedding():Boolean
allowPrinting | property |
allowPrinting:Boolean
[read-only] Since : | CS5 |
If true, the can font be printed.
public function get allowPrinting():Boolean
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
fontFamily | property |
fontFamily:String
[read-only] Since : | CS5 |
The name of the font family
public function get fontFamily():String
fontStyleName | property |
fontStyleName:String
[read-only] Since : | CS5 |
The name of the font style.
public function get fontStyleName():String
fontStyleNameNative | property |
fontStyleNameNative:String
[read-only] Since : | CS5 |
The native name of the font style.
public function get fontStyleNameNative():String
fontType | property |
fontType:FontTypes
[read-only] Since : | CS5 |
The type of font.
public function get fontType():FontTypes
fullName | property |
fullName:String
[read-only] Since : | CS5 |
The full font name.
public function get fullName():String
fullNameNative | property |
fullNameNative:String
[read-only] Since : | CS5 |
The full native name of the font.
public function get fullNameNative():String
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Font within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
location | property |
location:String
[read-only] Since : | CS5 |
The full path to the Font.
public function get location():String
name | property |
name:String
[read-only] Since : | CS5 |
The name of the Font.
public function get name():String
ordering | property |
ordering:String
[read-only] Since : | CS5 |
The ordering of a CID font.
public function get ordering():String
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the Font (a Document or Application).
public function get parent():Object
platformName | property |
platformName:String
[read-only] Since : | CS5 |
The platform font name.
public function get platformName():String
postscriptName | property |
postscriptName:String
[read-only] Since : | CS5 |
The PostScript name of the font.
public function get postscriptName():String
properties | property |
properties:Object
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
registry | property |
registry:String
[read-only] Since : | CS5 |
The registry of a CID font.
public function get registry():String
restrictedPrinting | property |
restrictedPrinting:Boolean
[read-only] Since : | CS5 |
If true, the font allows only restricted printing.
public function get restrictedPrinting():Boolean
status | property |
status:FontStatus
[read-only] Since : | CS5 |
The status of the font.
public function get status():FontStatus
version | property |
version:String
[read-only] Since : | CS5 |
The font version.
public function get version():String
writingScript | property |
writingScript:Number
[read-only] Since : | CS5 |
The writing script.
public function get writingScript():Number
addEventListenerFont | () | method |
public function addEventListenerFont(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 |
checkOpenTypeFeature | () | method |
public function checkOpenTypeFeature(usingParam:Object = null):Boolean
Since : | CS5 |
Checks whether the font supports the specified OpenType feature.
Parameters
usingParam:Object (default = null ) — (Object) The OpenType feature to check for, specified either as an OpenType feature or a string. Can accept: OpenTypeFeature enumerator or String.
|
Boolean |
createSubsetFont | () | method |
public function createSubsetFont(charactersForSubsetParam:String = null, fontDestinationParam:File = null):void
Since : | CS5 |
Create a copy of the font with just enough information to render the list of characters given.
Parameters
charactersForSubsetParam:String (default = null ) — (String) String with all the characters used in the resulting font.
| |
fontDestinationParam:File (default = null ) — (File) File location for the new font.
|
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
removeEventListenerFont | () | method |
public function removeEventListenerFont(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 |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |