AttachmentLoader

Package	com.adobe.icomm.assetplacement.controller
Class	public class AttachmentLoader
Inheritance	AttachmentLoader Object
Implements	IMXMLObject, IPackageObject, IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The attachment loader class is associated with a list of attachments in a package definition given a controller id. Furthermore it provides the ability to invoke INavigatorHost commands on any of the attachments in the list This may be done via the attachment name or by 0 based index.

Opening an attachment proper is not permitted from a navigator, only previewing is.

This class is not directly tied to any specific UIComponent. Instead it captures the behaviour of invoking various commands available in Acrobat in a way that can be used by any UI control.

View the examples

Public Properties

	Property		Defined By
		attachmentCount : int [read-only] The number of Attachment objects associated to this loader.	AttachmentLoader
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		host : INavigatorHost DEPRECATED The INavigatorHost object.	AttachmentLoader
		id : String The id attribute is the key that maps this component to an asset in the package definition file.	AttachmentLoader
		packageAttachments : IList [read-only] A list of Attachment objects who's controller id attribute matches the id of this object.	AttachmentLoader
		packageController : Controller [read-only] The controller object who's id matches the id of this object.	AttachmentLoader
		packageResource : Resource [read-only] The current Resource object who's controller id attribute matches the id of this object.	AttachmentLoader
		packageResources : IList [read-only] A list of Resource objects who's controller id attribute matches the id of this object.	AttachmentLoader

Public Methods

	Method		Defined By
		AttachmentLoader(id:String = "") Construct an AttachmentLoader.	AttachmentLoader
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	AttachmentLoader
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	AttachmentLoader
		findAttachmentByIndex(index:int):Boolean Lookup the attachment with the current index within the list of attachments this loader is associated with.	AttachmentLoader
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	AttachmentLoader
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		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
		previewAttachmentByIndex(index:int):void Lookup the attachment with the given index within the list of attachments this loader is associated with.	AttachmentLoader
		previewAttachmentByName(name:String):void Lookup the attachment with the current index within the list of attachments this loader is associated with.	AttachmentLoader
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	AttachmentLoader
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	AttachmentLoader

Property Detail

attachmentCount

property

attachmentCount:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The number of Attachment objects associated to this loader.

Implementation
public function get attachmentCount():int

host

property

host:INavigatorHost

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

DEPRECATED The INavigatorHost object. This is an interface to Acrobat and is used to ask Acrobat to preview attachment objects.

Implementation
public function get host():INavigatorHost
public function set host(value:INavigatorHost):void

id

property

id:String

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The id attribute is the key that maps this component to an asset in the package definition file. When the id is set, the AttachmentLoader will query the PackageDefinition for a list of Attachment objects that match this id. The Attachment objects can then be accessed using previewAttachmentByIndex() or previewAttachmentByName().

Implementation
public function get id():String
public function set id(value:String):void

Related API Elements

com.adobe.icomm.assetplacement.model.Resource

packageAttachments

property

packageAttachments:IList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A list of Attachment objects who's controller id attribute matches the id of this object.

Implementation
public function get packageAttachments():IList

packageController

property

packageController:Controller [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The controller object who's id matches the id of this object.

Implementation
public function get packageController():Controller

packageResource

property

packageResource:Resource [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

The current Resource object who's controller id attribute matches the id of this object.

Implementation
public function get packageResource():Resource

packageResources

property

packageResources:IList [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

A list of Resource objects who's controller id attribute matches the id of this object.

Implementation
public function get packageResources():IList

Constructor Detail

AttachmentLoader

()

Constructor

public function AttachmentLoader(id:String = "")

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Construct an AttachmentLoader. AttachmentLoaders can invoke INavigatorHost commands on attachments contained within an interactive document.

Parameters

id:String (default = "") — The controller id value of the <attachments> element this loader is associated with in the package definition.

Method Detail

addEventListener

()

method

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void

Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

After you successfully register an event listener, you cannot change its priority through additional calls to addEventListener(). To change a listener's priority, you must first call removeEventListener(). Then you can register the listener again with the new priority level.

After the listener is registered, subsequent calls to addEventListener() with a different value for either type or useCapture result in the creation of a separate listener registration. For example, if you first register a listener with useCapture set to true, it listens only during the capture phase. If you call addEventListener() again using the same listener object, but with useCapture set to false, you have two separate listeners: one that listens during the capture phase, and another that listens during the target and bubbling phases.

You cannot register an event listener for only the target phase or the bubbling phase. Those phases are coupled during registration because bubbling applies only to the ancestors of the target node.

When you no longer need an event listener, remove it by calling EventDispatcher.removeEventListener(); otherwise, memory problems might result. Objects with registered event listeners are not automatically removed from memory because the garbage collector does not remove objects that still have references.

Copying an EventDispatcher instance does not copy the event listeners attached to it. (If your newly created node needs an event listener, you must attach the listener after creating the node.) However, if you move an EventDispatcher instance, the event listeners attached to it move along with it.

If the event listener is being registered on a node while an event is also being processed on this node, the event listener is not triggered during the current phase but may be triggered during a later phase in the event flow, such as the bubbling phase.

If an event listener is removed from a node while an event is being processed on the node, it is still triggered by the current actions. After it is removed, the event listener is never invoked again (unless it is registered again for future processing).

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener function that processes the event. This function must accept an event object as its only parameter and must return nothing, as this example shows: `function(evt:Event):void` The function can have any name.

	`useCapture:Boolean` (default = `false`) — Determines whether the listener works in the capture phase or the target and bubbling phases. If `useCapture` is set to `true`, the listener processes the event only during the capture phase and not in the target or bubbling phase. If `useCapture` is `false`, the listener processes the event only during the target or bubbling phase. To listen for the event in all three phases, call `addEventListener()` twice, once with `useCapture` set to `true`, then again with `useCapture` set to `false`.

	`priority:int` (default = `0`) — The priority level of the event listener. Priorities are designated by a 32-bit integer. The higher the number, the higher the priority. All listeners with priority n are processed before listeners of priority n-1. If two or more listeners share the same priority, they are processed in the order in which they were added. The default priority is 0.

	`weakRef:Boolean` (default = `false`) — Determines whether the reference to the listener is strong or weak. A strong reference (the default) prevents your listener from being garbage-collected. A weak reference does not. Class-level member functions are not subject to garbage collection, so you can set `useWeakReference` to `true` for class-level member functions without subjecting them to garbage collection. If you set `useWeakReference` to `true` for a listener that is a nested inner function, the function will be garbge-collected and no longer persistent. If you create references to the inner function (save it in another variable) then it is not garbage-collected and stays persistent.

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.

Parameters

event:Event — The event object dispatched into the event flow.

Returns

Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.

findAttachmentByIndex

()

method

public function findAttachmentByIndex(index:int):Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 10

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Lookup the attachment with the current index within the list of attachments this loader is associated with. If found return TRUE. Otherwise return FALSE.

Parameters

index:int

Returns

Boolean

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Checks whether the EventDispatcher object has any listeners registered for a specific type of event. This allows you to determine where an EventDispatcher object has altered handling of an event type in the event flow hierarchy. To determine whether a specific event type will actually trigger an event listener, use IEventDispatcher.willTrigger().

The difference between hasEventListener() and willTrigger() is that hasEventListener() examines only the object to which it belongs, whereas willTrigger() examines the entire event flow for the event specified by the type parameter.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type is registered; false otherwise.

previewAttachmentByIndex

()

method

public function previewAttachmentByIndex(index:int):void

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Lookup the attachment with the given index within the list of attachments this loader is associated with. If found invoke the PREVIEW command via the INavigatorHost interface. If we get asked to preview an attachment before the id/packagedef/host has been set then we'll set a flag to immediately do the preview once they'ave all been set. Throw an error if the given index is out of range.

Parameters

index:int — The 0-based index of the attachment to preview.

previewAttachmentByName

()

method

public function previewAttachmentByName(name:String):void

Language Version:

ActionScript 3.0

Product Version:

Asset Placement Building Block 9.5

Runtime Versions:

AIR 1.0, Flash Player 9, Flash Player 10

Lookup the attachment with the current index within the list of attachments this loader is associated with. If found invoke the PREVIEW command via the INavigatorHost interface. If we get asked to preview an attachment before the id/packagedef/host has been set then we'll set a flag to immediately do the preview once they'ave all been set. Throws an error if no <attachment> entry with that name is found in the package definition or if one cannot be found within the host.

Parameters

name:String — The name of the attachment to preview. Should match the "name" attribute specified for the attachment in the package definition file.

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.

Parameters

	`type:String` — The type of event.

	`listener:Function` — The listener object to remove.

	`useCapture:Boolean` (default = `false`) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases. If the listener was registered for both the capture phase and the target and bubbling phases, two calls to `removeEventListener()` are required to remove both: one call with `useCapture` set to `true`, and another call with `useCapture` set to `false`.

willTrigger

()

method

public function willTrigger(type:String):Boolean

Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. This method returns true if an event listener is triggered during any phase of the event flow when an event of the specified type is dispatched to this EventDispatcher object or any of its descendants.

Parameters

type:String — The type of event.

Returns

Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.

Examples How to use this example

Consider a preview button declaration:

     <mx:Button id="myButton" width="100" height="50" label="View statement" click="// Pass in the controller id 'printDocument' in this case
                                                                                       var loader:AttachmentLoader = new AttachmentLoader('printDocument');
                                                                                       loader.previewAttachmentByName('printDocument.pdf');
                                                                                       //or loader.previewAttachmentByIndex(0)"/>

Alternatively you could do:

      <ap:AttachmentLoader id="printDocument" />
      <mx:Button id="myButton" width="100" height="50" label="View statement" click="printDocument.previewAttachmentByIndex(0);" />

Legal Notices | Online Privacy Policy

AttachmentLoader - AS3 Asset Placement

Classes x

attachmentCount

host

id

packageAttachments

packageController

packageResource

packageResources

AttachmentLoader

addEventListener

dispatchEvent

findAttachmentByIndex

hasEventListener

previewAttachmentByIndex

previewAttachmentByName

removeEventListener

willTrigger