AttachmentHeaderModel

Package	lc.procmgmt.ui.attachments
Class	public class AttachmentHeaderModel
Inheritance	AttachmentHeaderModel PresentationModel EventDispatcher 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

The AttachmentsHeaderModel class acts as the model for the AttachmentsHeader component.

Related API Elements

lc.procmgmt.ui.attachments.AttachmentHeader

Public Properties

	Property		Defined By
		allowNewAttachments : Boolean [read-only] The indicator that adding Attachments is permitted.	AttachmentHeaderModel
		allowNewNotes : Boolean [read-only] The indicator that adding Notes is permitted.	AttachmentHeaderModel
		attachmentPermissions : ArrayCollection [read-only] An array of the possible combinations of the AttachmentPermissions object that can be associated with an AttachmentHeader component.	AttachmentHeaderModel
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		errorString : String [read-only] The error string.	AttachmentHeaderModel
		file : FileReference [read-only] The FileReference object used to display the File Browse dialog box.	AttachmentHeaderModel
		fileName : String [read-only] The name of the attachment being added.	AttachmentHeaderModel
		isIncludeAttachments : Boolean [read-only] Indicator to include Attachments in the display.	AttachmentHeaderModel
		isIncludeNotes : Boolean [read-only] Indicator to include Notes in the display.	AttachmentHeaderModel
		note : String [read-only] The text contained in the note.	AttachmentHeaderModel
		permissionIndex : int [read-only] The index of the AttachmentPermissions object associated with the current Task object in the model's attachmentPermissions array.	AttachmentHeaderModel
		session : SessionMap A SessionMap object that stores information relating to the server session.	PresentationModel
		state : String [read-only] The name of the state the current view is in.	PresentationModel
		task : lc.procmgmt.domain:Task [read-only] The process management task that the attachments are associated with.	AttachmentHeaderModel
		taskACL : lc.procmgmt.domain:TaskACL [read-only] The TaskACL object associated with the current task.	AttachmentHeaderModel
		title : String [read-only] The text contained in the note title.	AttachmentHeaderModel

Public Methods

	Method		Defined By
		AttachmentHeaderModel() Constructor.	AttachmentHeaderModel
		addAttachment():void Adds the file property to the current Task object, with the specified AttachmentPermissions object set.	AttachmentHeaderModel
		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
		addNote():void Adds the title and note properties to the current Task object, with the specified AttachmentPermissions object set.	AttachmentHeaderModel
		bindProperty(destination:Object, destinationProperty:String, source:Object, sourceChain:Object, commitOnly:Boolean = false):ChangeWatcher Binds a public property on the destination object from a property or property chain on the source object.	PresentationModel
		clearFields():void Reinitializes the model's properties.	AttachmentHeaderModel
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getAttachmentFile():void Deprecated Since LiveCycle ES Update 1 (8.2): getAttachmentFile() is no longer used.	AttachmentHeaderModel
		getCSSStyle(declaration:String, styleProperty:String, defaultValue:Object = null):Object Returns the corresponding cascading style sheet (CSS) property to use based on the specified parameters.	PresentationModel
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initialize():void Initializes the presentation model after the view bindings are processed to prevent view bindings from overriding the initial model state.	PresentationModel
		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
		onTaskChangeHandler(taskACL:lc.procmgmt.domain:TaskACL):void Dispatches when the taskACL property changes on the Task object.	AttachmentHeaderModel
		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.	EventDispatcher
		selectLabel(item:Object):String Retrieves the label associated with the AttachmentPermissions object that was passed in.	AttachmentHeaderModel
		setAddAttachmentState():void Changes the state of this component to the AttachmentHeaderModel.STATE_ADD_ATTACHMENT state.	AttachmentHeaderModel
		setAddNoteState():void Changes the state of this component to the AttachmentHeaderModel.STATE_ADD_NOTE state.	AttachmentHeaderModel
		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.	EventDispatcher

Protected Methods

	Method		Defined By
		setState(newState:String):void Sets the state property to a new value and causes a PropertyChangeEvent event.	PresentationModel

Events

Click for more information on events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Public Constants

	Constant		Defined By
		NOTE_TITLE_MAXSIZE : int = 255 [static] A special value that indicates the maximum number of characters for a title in a note.	AttachmentHeaderModel
		STATE_ADD_ATTACHMENT : String = "addAttachmentState" [static] A special value that indicates that it is possible to add notes and attachments.	AttachmentHeaderModel
		STATE_ADD_ATTACHMENT_ONLY : String = "addAttachmentOnlyState" [static] A special value that indicates that it is possible to add only attachments.	AttachmentHeaderModel
		STATE_ADD_NOTE : String = "addNoteState" [static] A special value that indicates that the STATE_ADD_ATTACHMENT state set set; however, the user tried add a note.	AttachmentHeaderModel
		STATE_ADD_NOTE_ONLY : String = "addNoteOnlyState" [static] A special value that indicates that it is possible to add a note.	AttachmentHeaderModel

Property Detail

allowNewAttachments

property

allowNewAttachments:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.1

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The indicator that adding Attachments is permitted.

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 allowNewAttachments():Boolean

allowNewNotes

property

allowNewNotes:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Document Services - Workspace 9.0.0.1

Runtime Versions:

AIR (unsupported), Flash Player 9, Flash Player 10

The indicator that adding Notes is permitted.

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 allowNewNotes():Boolean

attachmentPermissions

property

attachmentPermissions:ArrayCollection [read-only]

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

An array of the possible combinations of the AttachmentPermissions object that can be associated with an AttachmentHeader component.

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 attachmentPermissions():ArrayCollection

errorString

property

errorString:String [read-only]

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 error string.

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 errorString():String

file

property

file:FileReference [read-only]

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 FileReference object used to display the File Browse dialog box.

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 file():FileReference

fileName

property

fileName:String [read-only]

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 name of the attachment being added.

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 fileName():String

isIncludeAttachments

property

isIncludeAttachments:Boolean [read-only]

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

Indicator to include Attachments in the display.

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 isIncludeAttachments():Boolean

isIncludeNotes

property

isIncludeNotes:Boolean [read-only]

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

Indicator to include Notes in the display.

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 isIncludeNotes():Boolean

note

property

note:String [read-only]

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 text contained in the note.

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 note():String

permissionIndex

property

permissionIndex:int [read-only]

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 index of the AttachmentPermissions object associated with the current Task object in the model's attachmentPermissions array.

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 permissionIndex():int

task

property

task:lc.procmgmt.domain:Task [read-only]

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 process management task that the attachments are associated with.

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 task():lc.procmgmt.domain:Task

taskACL

property

taskACL:lc.procmgmt.domain:TaskACL [read-only]

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 TaskACL object associated with the current task. The TaskACL object contains the settings from an AttachmentPermissions object associated with the current task and controls the state in which this component is viewed.

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 taskACL():lc.procmgmt.domain:TaskACL

Related API Elements

lc.procmgmt.domain.TaskACL
llc.procmgmt.domain.AttachmentPermissions

title

property

title:String [read-only]

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 text contained in the note title.

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 title():String

Constructor Detail

AttachmentHeaderModel

()

Constructor

public function AttachmentHeaderModel()

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.

Method Detail

addAttachment

()

method

public function addAttachment():void

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

Adds the file property to the current Task object, with the specified AttachmentPermissions object set.

Views typically call this method when the user clicks the OK button to add an attachment.

addNote

()

method

public function addNote():void

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

Adds the title and note properties to the current Task object, with the specified AttachmentPermissions object set.

Views typically call this method when the user clicks the OK button to add a note.

clearFields

()

method

public function clearFields():void

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

Reinitializes the model's properties. The following properties are reinitialized:

The file property is set to a value of null.
The note, title, fileName, and errorString properties are set to an empty string.
The permissionIndex property is set to a value of zero.

getAttachmentFile

()

method

public function getAttachmentFile():void

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

Deprecated Since LiveCycle ES Update 1 (8.2): getAttachmentFile() is no longer used.

This method is no longer available. It remains exposed so that you can compile applications using earlier versions of the API. In earlier releases of Workspace, this method displayed a File Browse dialog box from which a user can select the attachment file to add.

onTaskChangeHandler

()

method

public function onTaskChangeHandler(taskACL:lc.procmgmt.domain:TaskACL):void

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

Dispatches when the taskACL property changes on the Task object. It is used to properly set the state of the AttachmentHeader component based on the value of the taskACL object.

Parameters

taskACL:lc.procmgmt.domain:TaskACL — The ACL (access control list) associated with the current task.

selectLabel

()

method

public function selectLabel(item:Object):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

Retrieves the label associated with the AttachmentPermissions object that was passed in.

Parameters

item:Object — The permissions of an attachment.

Returns

String — The associated label of an item.

setAddAttachmentState

()

method

public function setAddAttachmentState():void

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

Changes the state of this component to the AttachmentHeaderModel.STATE_ADD_ATTACHMENT state.

This state allows the user to add an attachment through this component.

setAddNoteState

()

method

public function setAddNoteState():void

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

Changes the state of this component to the AttachmentHeaderModel.STATE_ADD_NOTE state.

This state allows the user to add a note through the AttachmentHeader component.

Constant Detail

NOTE_TITLE_MAXSIZE

Constant

public static const NOTE_TITLE_MAXSIZE:int = 255

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 the maximum number of characters for a title in a note.

STATE_ADD_ATTACHMENT

Constant

public static const STATE_ADD_ATTACHMENT:String = "addAttachmentState"

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 that it is possible to add notes and attachments.

STATE_ADD_ATTACHMENT_ONLY

Constant

public static const STATE_ADD_ATTACHMENT_ONLY:String = "addAttachmentOnlyState"

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 that it is possible to add only attachments.

STATE_ADD_NOTE

Constant

public static const STATE_ADD_NOTE:String = "addNoteState"

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 that the STATE_ADD_ATTACHMENT state set set; however, the user tried add a note.

STATE_ADD_NOTE_ONLY

Constant

public static const STATE_ADD_NOTE_ONLY:String = "addNoteOnlyState"

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 that it is possible to add a note.

Legal Notices | Online Privacy Policy

AttachmentHeaderModel - AS3 ADEP Workspace

Classes x

allowNewAttachments

allowNewNotes

attachmentPermissions

errorString

file

fileName

isIncludeAttachments

isIncludeNotes

note

permissionIndex

task

taskACL

title

AttachmentHeaderModel

addAttachment

addNote

clearFields

getAttachmentFile

onTaskChangeHandler

selectLabel

setAddAttachmentState

setAddNoteState

NOTE_TITLE_MAXSIZE

STATE_ADD_ATTACHMENT

STATE_ADD_ATTACHMENT_ONLY

STATE_ADD_NOTE

STATE_ADD_NOTE_ONLY