SwfAppButtonEvent

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

A SwfAppButtonEvent event is used to communicate between an application built with Flex (Flex application) and the buttons in the Workspace user interface.

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
		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
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined By
		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
		DISABLE_ROUTE_BUTTON : String = "disableRouteButton" [static] A special value that specifies to disable a specific route button in the Workspace user interface.	SwfAppButtonEvent
		ENABLE_ROUTE_BUTTON : String = "enableRouteButton" [static] A special value that specifies to enable a route button in the Workspace user interface.	SwfAppButtonEvent
		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
		RENAME_ROUTE_BUTTON : String = "renameRouteButton" [static] A special value that specifies to rename a specific route button in the Workspace user interface.	SwfAppButtonEvent
		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

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.

Parameters

	`type:String` — Specifies the type of event.

	`buttonName:String` (default = `null`) — Specifies the name of the button being changed.

	`newButtonName:String` (default = `null`) — Specifies the new name for the button.

	`newTooltip:String` (default = `null`) — Specifies the new tooltip text for the button.

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.

Legal Notices | Online Privacy Policy

SwfAppButtonEvent - AS3 ADEP Workspace

Classes x

buttonName

newButtonName

newTooltip

SwfAppButtonEvent

CHANGE_ROUTE_BUTTON_TOOLTIP

DISABLE_ROUTE_BUTTON

ENABLE_ROUTE_BUTTON

HIDE_ALL_ROUTE_BUTTONS

HIDE_ROUTE_BUTTON

HIDE_SAVE_BUTTON

RENAME_ROUTE_BUTTON

SHOW_ALL_ROUTE_BUTTONS

SHOW_ROUTE_BUTTON

SHOW_SAVE_BUTTON