| Package | com.adobe.icc.editors.handlers |
| Class | public class ListHandler |
| Inheritance | ListHandler  EventDispatcher Object |
| Implements | IAssetHandler |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| assetActions : IList
The list of AssetAction objects maintained by this handler. | ListHandler | ||
 | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentAction : AssetAction
The action that the handler is currently executing. | ListHandler | ||
| selectedAssets : Array
The array of list value objects currently selected by the user. | ListHandler | ||
| workingAsset : ListModel
The List domain object that the handler is currently working with. | ListHandler | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | ListHandler | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Dispatches an event into the event flow. | EventDispatcher | |
Returns the asset type handled by this handler. | ListHandler | ||
This method is invoked by the Asset Manager framework whenever user requests an action
on an object of type List. | ListHandler | ||
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
Called by the Asset Manager framework to give the handlers time to initialize. | ListHandler | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Returns the primitive value of the specified object. | Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
Called internally when this handler is handling an action of type Activate. | ListHandler | ||
Called internally when this handler is handling an action of type Copy. | ListHandler | ||
Called internally when this handler is handling an action of type Create. | ListHandler | ||
Called internally when this handler is handling an action of type Delete. | ListHandler | ||
Called internally when this handler is handling an action of type Edit. | ListHandler | ||
Called internally when this handler is handling an action of type ExportDependencies. | ListHandler | ||
Handles the default Action, that is, AssetActionEvent.ACTIN_DEFAULT. | ListHandler | ||
Called internally when this handler is handling an action of type View. | ListHandler | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when an handling of an action is complete. | ListHandler | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when an action handled by this handler requires an editor window to be launched. | ListHandler | |||
| Constant | Defined By | ||
|---|---|---|---|
| ACTION_ACTIVATE : String = "Activate" [static]
Specifies the name of the action related to the activation of an asset. | ListHandler | ||
| ACTION_COPY : String = "Copy" [static]
Specifies the name of the action related to copying an asset. | ListHandler | ||
| ACTION_CREATE : String = "Create" [static]
Specifies the name of the action related to the creation of an asset. | ListHandler | ||
| ACTION_DELETE : String = "Delete" [static]
Specifies the name of the action related to the deletion of an asset. | ListHandler | ||
| ACTION_EDIT : String = "Edit" [static]
Specifies the name of the action related to editing an asset. | ListHandler | ||
| ACTION_EXPORTDEPENDENCY : String = "ExportDependencies" [static]
Specifies the name of the action related to exporting dependencies of an asset. | ListHandler | ||
| ACTION_VIEW : String = "View" [static]
Specifies the name of the action related to viewing an asset. | ListHandler | ||
| ASSET_TYPE : String = "ListDataModule" [static]
Specifies the asset type handled by this handler. | ListHandler | ||
assetActions | property |
assetActions:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The list of AssetAction objects maintained by this handler. This list is used by the Asset Manager framework to determine which action to enable. The Asset Manager framework looks for the value of the enabled flag in the AssetAction object to determine the action to enable. The handler updates the flags whenever the list of selected assets changes.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get assetActions():IList public function set assetActions(value:IList):voidcurrentAction | property |
currentAction:AssetAction| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The action that the handler is currently executing. This is useful when the editor needs to know the action that the working asset is being acted upon. For example, for a view action, the editor needs to disable some of the fields.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get currentAction():AssetAction public function set currentAction(value:AssetAction):voidselectedAssets | property |
selectedAssets:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The array of list value objects currently selected by the user. This is set by the Asset Manager framework whenever a user selects or deselects an item of type List.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get selectedAssets():Array public function set selectedAssets(value:Array):voidworkingAsset | property |
workingAsset:ListModel| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
The List domain object that the handler is currently working with. The handler creates this domain object from the shallow value object that it receives from the Asset Manager framework. The working asset is used by the asset editor to display the asset to the user in a desired presentation format.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get workingAsset():ListModel public function set workingAsset(value:ListModel):voidListHandler | () | Constructor |
public function ListHandler()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Constructor.
activateLists | () | method |
protected function activateLists():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type Activate. The default implementation iteratively activates all the selected list value objects. Activation does not require creation of a domain object. Therefore, the activate action has no impact on the value of working asset. In addition, the launchEditor event is never dispatched while handling the activate action.
copyList | () | method |
protected function copyList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type Copy. The default implementation creates a new list domain object from the selected list value object, assigns it as the working asset, and dispatches the launchEditor event so that the framework can display the editor window to the user. This method can be extended to override the "copy" behavior of this handler. For example, if viewing action requires some preprocessing or some checks need to be made.
createList | () | method |
protected function createList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type Create. The default implementation creates a new list domain object, assigns it as the working asset, and dispatches the launchEditor event so that the framework can display the editor window to the user. This method can be extended to override the creation behavior of this handler. For example, if creation requires some preprocessing or some checks need to be made.
deleteLists | () | method |
protected function deleteLists(showWaring:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type Delete. The default implementation iteratively deletes all the selected list value objects. A confirmation Alert dialog is displayed to the user. To prevent this dialog box from being displayed set the showWarning flag value to false. Deletion does not require creation of a domain object. Therefore, the delete action has no impact on the value of working asset. In addition, the launchEditor event is never dispatched while handling the delete action.
Parameters
showWaring:Boolean (default = true) |
editList | () | method |
protected function editList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type Edit. The default implementation creates a new list domain object from the selected list value object.
exportListDependencies | () | method |
protected function exportListDependencies():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type ExportDependencies. The default implementation invokes a service that fetches the dependencies and exports an XML output. This method can be extended to override the "ExportDependencies" behavior of this handler. For example, to show a grid that lists the dependent assets.
getAssetType | () | method |
public function getAssetType():String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Returns the asset type handled by this handler. This is used by the Asset Manager framework to route actions to appropriate handlers.
ReturnsString — The string that represents the asset type.
|
handleAction | () | method |
public function handleAction(event:AssetActionEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
This method is invoked by the Asset Manager framework whenever user requests an action on an object of type List. This method is called for all the actions requested by the user. It internally routes action handling to the appropriate templatized method, such as createList() or editList().
Parameters
event:AssetActionEvent — The event object of type AssetActionEvent that is raised by the Asset Manager framework.
|
handleDefaultAction | () | method |
protected function handleDefaultAction(event:AssetActionEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Handles the default Action, that is, AssetActionEvent.ACTIN_DEFAULT. For example, double-clicking an item in the search results grid. If the user has edit permission, then the asset opens in edit mode. If the user has view permission, the asset opens in view mode.
Parameters
event:AssetActionEvent — The event object of type AssetActionEvent that is dispatched by the Asset Manager framework.
|
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called by the Asset Manager framework to give the handlers time to initialize.
viewList | () | method |
protected function viewList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Called internally when this handler is handling an action of type View. The default implementation creates a new list domain object from the selected list value object, assigns it as the working asset, and dispatches the launchEditor event so that the framework can display the editor window to the user. This method can be extended to override the "view" behavior of this handler. For example, if viewing action requires some preprocessing or some checks need to be made.
assetActionComplete | Event |
com.adobe.livecycle.assetmanager.client.event.AssetActionCompleteEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Dispatched when an handling of an action is complete. This can be used by the framework or the application to perform any additional activities. For example, to display an alert box.
launchEditor | Event |
mx.events.FlexEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Dispatched when an action handled by this handler requires an editor window to be launched. The actions that require displaying the editor window to the user are Create, View, Edit, and Copy.
ACTION_ACTIVATE | Constant |
public static const ACTION_ACTIVATE:String = "Activate"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to the activation of an asset.
ACTION_COPY | Constant |
public static const ACTION_COPY:String = "Copy"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to copying an asset.
ACTION_CREATE | Constant |
public static const ACTION_CREATE:String = "Create"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to the creation of an asset.
ACTION_DELETE | Constant |
public static const ACTION_DELETE:String = "Delete"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to the deletion of an asset.
ACTION_EDIT | Constant |
public static const ACTION_EDIT:String = "Edit"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to editing an asset.
ACTION_EXPORTDEPENDENCY | Constant |
public static const ACTION_EXPORTDEPENDENCY:String = "ExportDependencies"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to exporting dependencies of an asset.
ACTION_VIEW | Constant |
public static const ACTION_VIEW:String = "View"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the name of the action related to viewing an asset.
ASSET_TYPE | Constant |
public static const ASSET_TYPE:String = "ListDataModule"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR 1.0, Flash Player 9, Flash Player 10 |
Specifies the asset type handled by this handler.
Wed Nov 21 2018, 06:34 AM -08:00