Package | com.adobe.incopy |
Class | public class Dialog |
Inheritance | Dialog ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
canCancel : Boolean
If true, creates a Cancel button in the dialog that allows users to close the dialog without saving any selections. | Dialog | ||
dialogColumns : DialogColumns [read-only]
A collection of dialog columns. | Dialog | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | Dialog | ||
events : Events [read-only]
A collection of events. | Dialog | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the Dialog. | Dialog | ||
index : Number [read-only]
The index of the Dialog within its containing object. | Dialog | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | Dialog | ||
label : String
A property that can be set to any string. | Dialog | ||
name : String
The name of the Dialog. | Dialog | ||
parent : Application [read-only]
The parent of the Dialog (a Application). | Dialog | ||
properties : Object
A property that allows setting of several properties at the same time. | Dialog |
Method | Defined By | ||
---|---|---|---|
addEventListenerDialog(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | Dialog | ||
destroy():void
Destroys the dialog object. | Dialog | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | Dialog | ||
![]() | 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. | Dialog | ||
![]() | 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 | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | Dialog | ||
![]() | 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 | |
removeEventListenerDialog(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | Dialog | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
show():Boolean
Displays the dialog. | Dialog | ||
toSpecifier():String
Retrieves the object specifier. | Dialog | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
canCancel | property |
canCancel:Boolean
Since : | CS5 |
If true, creates a Cancel button in the dialog that allows users to close the dialog without saving any selections. If false, the dialog contains an OK button but no Cancel button.
public function get canCancel():Boolean
public function set canCancel(value:Boolean):void
dialogColumns | property |
dialogColumns:DialogColumns
[read-only] Since : | CS5 |
A collection of dialog columns.
public function get dialogColumns():DialogColumns
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
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the Dialog.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the Dialog 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
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
name | property |
name:String
Since : | CS5 |
The name of the Dialog.
public function get name():String
public function set name(value:String):void
parent | property |
parent:Application
[read-only] Since : | CS5 |
The parent of the Dialog (a Application).
public function get parent():Application
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
addEventListenerDialog | () | method |
public function addEventListenerDialog(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 |
destroy | () | method |
public function destroy():void
Since : | CS5 |
Destroys the dialog object. Note: Dialog objects remain in memory until you destroy them or quit the program.
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
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.
|
removeEventListenerDialog | () | method |
public function removeEventListenerDialog(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 |
show | () | method |
public function show():Boolean
Since : | CS5 |
Displays the dialog.
ReturnsBoolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |