| Package | lc.procmgmt.events |
| Class | public class SwfAppButtonEvent |
| Inheritance | SwfAppButtonEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
SwfAppButtonEvent event is used to communicate between an application built with Flex (Flex
application) and the buttons in the Workspace user interface.
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| buttonName : String
The target button name. | SwfAppButtonEvent | ||
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| newButtonName : String
The new button name. | SwfAppButtonEvent | ||
| newTooltip : String
The new tooltip for the button. | SwfAppButtonEvent | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
SwfAppButtonEvent(type:String, buttonName:String = null, newButtonName:String = null, newTooltip:String = null)
Constructor. | SwfAppButtonEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| ACTIVATE : String = "activate" [static]
The ACTIVATE constant defines the value of the type property of an activate event object. | Event | |
| ADDED : String = "added" [static]
The Event.ADDED constant defines the value of the type property of
an added event object. | Event | |
| ADDED_TO_STAGE : String = "addedToStage" [static]
The Event.ADDED_TO_STAGE constant defines the value of the type
property of an addedToStage event object. | Event | |
| CANCEL : String = "cancel" [static]
The Event.CANCEL constant defines the value of the type property of a cancel event object. | Event | |
| CHANGE : String = "change" [static]
The Event.CHANGE constant defines the value of the type property of a change event object. | Event | |
| CHANGE_ROUTE_BUTTON_TOOLTIP : String = "changeRouteButtonTooltip" [static]
A special value that indicates to change the tooltip of a specific route button in the Workspace user interface. | SwfAppButtonEvent | ||
| CLEAR : String = "clear" [static]
The Event.CLEAR constant defines the value of the type property
of a clear event object. | Event | |
| CLOSE : String = "close" [static]
The Event.CLOSE constant defines the value of the type property of a close event object. | Event | |
| CLOSING : String = "closing" [static]
The Event.CLOSING constant defines the value of the
type property of a closing event object. | Event | |
| COMPLETE : String = "complete" [static]
The Event.COMPLETE constant defines the value of the type property of a complete event object. | Event | |
| CONNECT : String = "connect" [static]
The Event.CONNECT constant defines the value of the type property of a connect event object. | Event | |
| CONTEXT3D_CREATE : String = "context3DCreate" [static]
The Event.CONTEXT3D_CREATE constant defines the value of the type
property of a context3Dcreate event object. | Event | |
| COPY : String = "copy" [static]
Defines the value of the type property of a copy event object. | Event | |
| CUT : String = "cut" [static]
Defines the value of the type property of a cut event object. | Event | |
| DEACTIVATE : String = "deactivate" [static]
The Event.DEACTIVATE constant defines the value of the type property of a deactivate event object. | Event | |
| DISABLE_ROUTE_BUTTON : String = "disableRouteButton" [static]
A special value that specifies to disable a specific route button in the Workspace user interface. | SwfAppButtonEvent | ||
| DISPLAYING : String = "displaying" [static]
The Event.DISPLAYING constant defines the value of the type property of a displaying event object. | Event | |
| ENABLE_ROUTE_BUTTON : String = "enableRouteButton" [static]
A special value that specifies to enable a route button in the Workspace user interface. | SwfAppButtonEvent | ||
| ENTER_FRAME : String = "enterFrame" [static]
The Event.ENTER_FRAME constant defines the value of the type property of an enterFrame event object. | Event | |
| EXIT_FRAME : String = "exitFrame" [static]
The Event.EXIT_FRAME constant defines the value of the type property of an exitFrame event object. | Event | |
| EXITING : String = "exiting" [static]
The Event.EXITING constant defines the value of the type property of an exiting event object. | Event | |
| FRAME_CONSTRUCTED : String = "frameConstructed" [static]
The Event.FRAME_CONSTRUCTED constant defines the value of the type property of an frameConstructed event object. | Event | |
| FULLSCREEN : String = "fullScreen" [static]
The Event.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. | Event | |
| HIDE_ALL_ROUTE_BUTTONS : String = "hideAllRouteButtons" [static]
A special value that specifies to hide all route buttons in the Workspace user interface. | SwfAppButtonEvent | ||
| HIDE_ROUTE_BUTTON : String = "hideRouteButton" [static]
A special value that specifies to hide a specific route button in the Workspace user interface. | SwfAppButtonEvent | ||
| HIDE_SAVE_BUTTON : String = "hideSaveButton" [static]
A special value that specifies to hide the Save button in the Workspace user interface. | SwfAppButtonEvent | ||
| HTML_BOUNDS_CHANGE : String = "htmlBoundsChange" [static]
The Event.HTML_BOUNDS_CHANGE constant defines the value of the type property of an htmlBoundsChange event object. | Event | |
| HTML_DOM_INITIALIZE : String = "htmlDOMInitialize" [static]
The Event.HTML_DOM_INITIALIZE constant defines the value of the type property
of an htmlDOMInitialize event object. | Event | |
| HTML_RENDER : String = "htmlRender" [static]
The Event.HTML_RENDER constant defines the value of the type property of an htmlRender event object. | Event | |
| ID3 : String = "id3" [static]
The Event.ID3 constant defines the value of the type property of an id3 event object. | Event | |
| INIT : String = "init" [static]
The Event.INIT constant defines the value of the type property of an init event object. | Event | |
| LOCATION_CHANGE : String = "locationChange" [static]
The Event.LOCATION_CHANGE constant defines the value of the type property of a locationChange event object. | Event | |
| MOUSE_LEAVE : String = "mouseLeave" [static]
The Event.MOUSE_LEAVE constant defines the value of the type property of a mouseLeave event object. | Event | |
| NETWORK_CHANGE : String = "networkChange" [static]
The Event.NETWORK_CHANGE constant defines the value of the type property of a networkChange event object. | Event | |
| OPEN : String = "open" [static]
The Event.OPEN constant defines the value of the type property of an open event object. | Event | |
| PASTE : String = "paste" [static]
The Event.PASTE constant defines the value of the type property of a paste event object. | Event | |
| PREPARING : String = "preparing" [static]
The Event.PREPARING constant defines the value of the type property of a preparing event object. | Event | |
| REMOVED : String = "removed" [static]
The Event.REMOVED constant defines the value of the type property of
a removed event object. | Event | |
| REMOVED_FROM_STAGE : String = "removedFromStage" [static]
The Event.REMOVED_FROM_STAGE constant defines the value of the type
property of a removedFromStage event object. | Event | |
| RENAME_ROUTE_BUTTON : String = "renameRouteButton" [static]
A special value that specifies to rename a specific route button in the Workspace user interface. | SwfAppButtonEvent | ||
| RENDER : String = "render" [static]
The Event.RENDER constant defines the value of the type property of a render event object. | Event | |
| RESIZE : String = "resize" [static]
The Event.RESIZE constant defines the value of the type property of a resize event object. | Event | |
| SCROLL : String = "scroll" [static]
The Event.SCROLL constant defines the value of the type property of a scroll event object. | Event | |
| SELECT : String = "select" [static]
The Event.SELECT constant defines the value of the type property of a select event object. | Event | |
| SELECT_ALL : String = "selectAll" [static]
The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object. | Event | |
| SHOW_ALL_ROUTE_BUTTONS : String = "showAllRouteButtons" [static]
A special value that specifies to show all route buttons in the Workspace user interface. | SwfAppButtonEvent | ||
| SHOW_ROUTE_BUTTON : String = "showRouteButton" [static]
A special value that specifies to show a specific route button in the Workspace user interface. | SwfAppButtonEvent | ||
| SHOW_SAVE_BUTTON : String = "showSaveButton" [static]
A special value that specifies to display the Save button in the Workspace user interface. | SwfAppButtonEvent | ||
| SOUND_COMPLETE : String = "soundComplete" [static]
The Event.SOUND_COMPLETE constant defines the value of the type property of a soundComplete event object. | Event | |
| STANDARD_ERROR_CLOSE : String = "standardErrorClose" [static]
The Event.STANDARD_ERROR_CLOSE constant defines the value of the type property of a standardErrorClose event object. | Event | |
| STANDARD_INPUT_CLOSE : String = "standardInputClose" [static]
The Event.STANDARD_INPUT_CLOSE constant defines the value of the type property of a standardInputClose event object. | Event | |
| STANDARD_OUTPUT_CLOSE : String = "standardOutputClose" [static]
The Event.STANDARD_OUTPUT_CLOSE constant defines the value of the type property of a standardOutputClose event object. | Event | |
| TAB_CHILDREN_CHANGE : String = "tabChildrenChange" [static]
The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object. | Event | |
| TAB_ENABLED_CHANGE : String = "tabEnabledChange" [static]
The Event.TAB_ENABLED_CHANGE constant defines the value of the type
property of a tabEnabledChange event object. | Event | |
| TAB_INDEX_CHANGE : String = "tabIndexChange" [static]
The Event.TAB_INDEX_CHANGE constant defines the value of the
type property of a tabIndexChange event object. | Event | |
| TEXT_INTERACTION_MODE_CHANGE : String = "textInteractionModeChange" [static]
The Event.TEXT_INTERACTION_MODE_CHANGE constant defines the value of the type property of an interaction mode event object. | Event | |
| UNLOAD : String = "unload" [static]
The Event.UNLOAD constant defines the value of the type property of an unload event object. | Event | |
| USER_IDLE : String = "userIdle" [static]
The Event.USER_IDLE constant defines the value of the type property of a userIdle event object. | Event | |
| USER_PRESENT : String = "userPresent" [static]
The Event.USER_PRESENT constant defines the value of the type property of a userPresent event object. | Event | |
Property Detail
buttonName | property |
public var buttonName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The target button name.
newButtonName | property |
public var newButtonName:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The new button name.
newTooltip | property |
public var newTooltip:String| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
The new tooltip for the button.
Constructor Detail
SwfAppButtonEvent | () | Constructor |
public function SwfAppButtonEvent(type:String, buttonName:String = null, newButtonName:String = null, newTooltip:String = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
Constructor.
Parameterstype:String — Specifies the type of event.
| |
buttonName:String (default = null) | |
newButtonName:String (default = null) | |
newTooltip:String (default = null) |
Constant Detail
CHANGE_ROUTE_BUTTON_TOOLTIP | Constant |
public static const CHANGE_ROUTE_BUTTON_TOOLTIP:String = "changeRouteButtonTooltip"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that indicates to change the tooltip of a specific route button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
DISABLE_ROUTE_BUTTON | Constant |
public static const DISABLE_ROUTE_BUTTON:String = "disableRouteButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to disable a specific route button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
ENABLE_ROUTE_BUTTON | Constant |
public static const ENABLE_ROUTE_BUTTON:String = "enableRouteButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to enable a route button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
HIDE_ALL_ROUTE_BUTTONS | Constant |
public static const HIDE_ALL_ROUTE_BUTTONS:String = "hideAllRouteButtons"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to hide all route buttons in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
HIDE_ROUTE_BUTTON | Constant |
public static const HIDE_ROUTE_BUTTON:String = "hideRouteButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to hide a specific route button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
HIDE_SAVE_BUTTON | Constant |
public static const HIDE_SAVE_BUTTON:String = "hideSaveButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to hide the Save button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
RENAME_ROUTE_BUTTON | Constant |
public static const RENAME_ROUTE_BUTTON:String = "renameRouteButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to rename a specific route button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
SHOW_ALL_ROUTE_BUTTONS | Constant |
public static const SHOW_ALL_ROUTE_BUTTONS:String = "showAllRouteButtons"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to show all route buttons in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
SHOW_ROUTE_BUTTON | Constant |
public static const SHOW_ROUTE_BUTTON:String = "showRouteButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to show a specific route button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
SHOW_SAVE_BUTTON | Constant |
public static const SHOW_SAVE_BUTTON:String = "showSaveButton"| Language Version: | ActionScript 3.0 |
| Product Version: | Adobe Digital Enterprise Platform Document Services - Workspace 9 |
| Runtime Versions: | AIR (unsupported), Flash Player 9, Flash Player 10 |
A special value that specifies to display the Save button in the Workspace user interface.
The properties of the Event object have the following values:
| Property | Value |
|---|---|
bubbles | True |
cancelable | False; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object
with an event listener. |
target | The object that dispatched the event;
use the currentTarget property to always access the
Object listening for the event. |
Mon Nov 28 2011, 06:48 AM -08:00