| Package | com.adobe.icc.editors.handlers |
| Class | public class CategoryHandler |
| Inheritance | CategoryHandler  EventDispatcher Object |
| Implements | IAssetHandler |
| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| assetActions : IList
The list of AssetAction objects maintained by this handler. | CategoryHandler | ||
 | 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. | CategoryHandler | ||
| selectedAssets : Array
The array of category value objects currently selected by the user. | CategoryHandler | ||
| workingAsset : CategoryModel
The Category Domain Object that the handler is currently working with. | CategoryHandler | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | CategoryHandler | ||
| 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. | CategoryHandler | ||
This method is invoked by the asset manager framework whenever user requests an action
on an object of type category. | CategoryHandler | ||
|
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 giving the handlers a chance to initialize themselves. | CategoryHandler | ||
|
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 Create. | CategoryHandler | ||
Called internally when this handler is handling an action of type Delete. | CategoryHandler | ||
Called internally when this handler is handling an action of type Edit. | CategoryHandler | ||
handles the default Action(AssetActionEvent.ACTIN_DEFAULT) such as Item double click on search results grid. | CategoryHandler | ||
Called internally when this handler is handling an action of type View. | CategoryHandler | ||
| 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. | CategoryHandler | |||
| assetActionsChanged event is thrown by the Handler when the selected item in results viewer change and it updates the correct handler selected assets. | CategoryHandler | |||
| [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. | CategoryHandler | |||
| Constant | Defined By | ||
|---|---|---|---|
| ACTION_CREATE : String = "Create" [static]
Constant for the name of the action related to creation of an asset. | CategoryHandler | ||
| ACTION_DELETE : String = "Delete" [static]
Constant for the name of the action related to deletion of an asset. | CategoryHandler | ||
| ACTION_EDIT : String = "Edit" [static]
Constant for the name of the action related to editing of an asset. | CategoryHandler | ||
| ACTION_VIEW : String = "View" [static]
Constant for the name of the action related to viewing of an asset. | CategoryHandler | ||
| ACTION_VIEW_DEPENDENCY : String = "ViewDependency" [static]
Constant for the name of the action related to view dependencies of an asset. | CategoryHandler | ||
| ASSET_TYPE : String = "Category" [static]
Constant for the Asset Type handled by this handler. | CategoryHandler | ||
assetActions | property |
assetActions:IList| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
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 same and handler updates the flags everytime 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 (unsupported), Flash Player 10.2 |
The action that the handler is currently executing. This is useful in cases when the editor needs to know the action that the working asset is being acted upon. For instance, the editor might need to disable some of the fields if it is a view action.
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 (unsupported), Flash Player 10.2 |
The array of category value objects currently selected by the user. This is set by the asset manager framework everytime a user selects or deselects an item of type category.
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:CategoryModel| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
The Category 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():CategoryModel public function set workingAsset(value:CategoryModel):voidCategoryHandler | () | Constructor |
public function CategoryHandler()| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Constructor.
createCategory | () | method |
protected function createCategory():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Called internally when this handler is handling an action of type Create. The default implementation creates a new category 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 instance, if creation requires some preprocessing or some checks that need to be made, the same can be done by overriding this method.
deleteCategories | () | method |
protected function deleteCategories(showWaring:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Called internally when this handler is handling an action of type Delete. The default implementation iteratively deletes all the selected category value objects. A confirmation Alert dialog is shown to the user but can be curbed by setting the showWarning flag value to false. Deletion does not require creation of a domain object. Hence, the delete action has no impact on the value of working asset. Moreover, the launchEditor event is never dispatched while handling the delete action.
Parameters
showWaring:Boolean (default = true) |
editCategory | () | method |
protected function editCategory():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Called internally when this handler is handling an action of type Edit. The default implementation creates a new category domain object from the selected category value object.
getAssetType | () | method |
public function getAssetType():String| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Returns the asset type handled by this handler. This is used by the asset manager framework to route actions to appropriate handlers.
ReturnsString — the asset type handled by this handler
|
handleAction | () | method |
public function handleAction(event:AssetActionEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
This method is invoked by the asset manager framework whenever user requests an action on an object of type category. This method is called for all the actions requested by the user. The action handling is internally routed to the correcting templatized methods like createLayout(), editLayout() etc.
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 (unsupported), Flash Player 10.2 |
handles the default Action(AssetActionEvent.ACTIN_DEFAULT) such as Item double click on search results grid. If user has edit permission, then asset is opened in edit mode. otherwise if user has view peermission then asset is opened in view mode.
Parameters
event:AssetActionEvent — AssetActionEvent containing the action information.
|
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Called by the asset manager framework giving the handlers a chance to initialize themselves.
viewCategory | () | method |
protected function viewCategory():void| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Called internally when this handler is handling an action of type View. The default implementation creates a new category domain object from the selected category 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 instance, if viewing action requires some preprocessing or some checks that need to be made, the same can be done by overriding this method.
assetActionComplete | Event |
com.adobe.livecycle.assetmanager.client.event.AssetActionCompleteEventproperty AssetActionCompleteEvent.type =
com.adobe.livecycle.assetmanager.client.event.AssetActionCompleteEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Dispatched when an handling of an action is complete. This can be used by the framework or the application to perform any additional activities e.g. display of a toast, alert box etc.
assetActionsChanged | Event |
com.adobe.livecycle.assetmanager.client.event.AssetActionsChangeEventproperty AssetActionsChangeEvent.type =
com.adobe.livecycle.assetmanager.client.event.AssetActionsChangeEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
assetActionsChanged event is thrown by the Handler when the selected item in results viewer change and it updates the correct handler selected assets. It is redispatched by the AssetHandlerRegistry and finally handled by AssetManagerView
launchEditor | Event |
com.adobe.livecycle.assetmanager.client.event.AssetActionEventproperty AssetActionEvent.type =
com.adobe.livecycle.assetmanager.client.event.AssetActionEvent| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Dispatched when an action handled by this handler requires an editor window to be launched. Create/View/Edit/Copy are the actions that require displaying the editor window to the user.
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 (unsupported), Flash Player 10.2 |
Constant for the name of the action related to 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 (unsupported), Flash Player 10.2 |
Constant for the name of the action related to 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 (unsupported), Flash Player 10.2 |
Constant for the name of the action related to editing 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 (unsupported), Flash Player 10.2 |
Constant for the name of the action related to viewing of an asset.
ACTION_VIEW_DEPENDENCY | Constant |
public static const ACTION_VIEW_DEPENDENCY:String = "ViewDependency"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 10.0 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Constant for the name of the action related to view dependencies of an asset.
ASSET_TYPE | Constant |
public static const ASSET_TYPE:String = "Category"| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Constant for the Asset Type handled by this handler.
Mon Apr 10 2017, 12:28 PM -07:00