FlexConfiguration

Package	com.adobe.consulting.pst.vo
Class	public class FlexConfiguration
Inheritance	FlexConfiguration Object
Implements	IEventDispatcher

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Object for transporting configuration parameters from the server to Flex applications.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		applicationTimeOut : int Application Idle time out in seconds	FlexConfiguration
		appVersion : String CM Version string.	FlexConfiguration
		assetNameCharset : String Set of characters that can be used for the name property of the editors	FlexConfiguration
		authorInstance : Boolean Boolean indicating wthether the server to which the client is connected is an Author Instance or Publish Instance;	FlexConfiguration
		baseurl : String [read-only] Fetches the Base URL for constructing outgoing URLs in the form of {protocol}://{server}[:{port}] with no trailing slash.	FlexConfiguration
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contentColor : String The highlighting color to be applied on the selected Content (in Doc Composer).	FlexConfiguration
		contentHighlightType : String The highlighting type to be done on the selected Content (in Doc Composer).	FlexConfiguration
		contextUrl : String [read-only] Fetches the in-context URL: combination of {baseurl}/{pscmContext} that will never end with a slash.	FlexConfiguration
		exportDefinitionService : String Export Definition service destination	FlexConfiguration
		exportDefinitionServiceUrl : String [read-only] Fetches the Export Dependencies Service URL: combination of {baseurl}/{pscmContext}/{exportDefinitionService} that will never end with a slash.	FlexConfiguration
		exportDependenciesService : String ExportDependencies service destination within context root: {baseurl}/{pscmContext}/{exportDependencies}.	FlexConfiguration
		exportDependenciesServiceUrl : String [read-only] Fetches the Export Dependencies Service URL: combination of {baseurl}/{pscmContext}/{exportDependenciesService} that will never end with a slash.	FlexConfiguration
		fieldColor : String The highlighting color to be applied on the selected Field (in Doc Composer).	FlexConfiguration
		fieldHighlightType : String The highlighting type to be done on the selected Field (in Doc Composer).	FlexConfiguration
		formLocale : String Locale for the Flex application to initialize itself.	FlexConfiguration
		indent : Number The indentation value to be applied when indenting modules in a Target (in Doc Composer)	FlexConfiguration
		loginMode : String Login Mode for Flex apps with User Management.	FlexConfiguration
		pscmContext : String Context root specifying where ICC apps and services are located within the base URL: {baseurl}/{pscmContext}.	FlexConfiguration
		renderParamFile : String Render Service: URL parameter for requesting a file (actual bytes) once the file has been rendered: {renderServiceUrl}?{renderParamFile}={fileName}.	FlexConfiguration
		renderService : String Render Service destination within context root: {baseurl}/{pscmContext}/{renderService}.	FlexConfiguration
		renderServiceUrl : String [read-only] Fetches the Render Service URL: combination of {baseurl}/{pscmContext}/{renderService} that will never end with a slash.	FlexConfiguration
		submitPdfType : String Type of PDF to pass to the letter's post process.	FlexConfiguration
		submitService : String Submit Service destination within context root: {baseurl}/{pscmContext}/{submitService}.	FlexConfiguration
		submitServiceUrl : String [read-only] Fetches the Submit Service URL: combination of {baseurl}/{pscmContext}/{submitService} that will never end with a slash.	FlexConfiguration
		targetColor : String The highlighting color to be applied on a Target (in Doc Composer).	FlexConfiguration
		targetHighlightType : String The highlighting type to be done on a Target (in Doc Composer).	FlexConfiguration
		tmpfolder : String Temporary folder for any kind of file operation.	FlexConfiguration

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		FlexConfiguration() Constructor	FlexConfiguration
		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.	FlexConfiguration
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	FlexConfiguration
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	FlexConfiguration
		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
		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.	FlexConfiguration
		setBaseUrl(vBaseUrl:String):void Explicitly set the baseUrl.	FlexConfiguration
		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.	FlexConfiguration

Public Constants

	Constant		Defined By
		LOGINMODE_BASIC : String = "basic" [static] Login mode.	FlexConfiguration
		LOGINMODE_NOLOGIN : String = "nologin" [static] Login mode.	FlexConfiguration
		LOGINMODE_SSO : String = "sso" [static] Login mode.	FlexConfiguration
		SUBMITPDFTYPE_INTERACTIVE : String = "interactive" [static] Submit PDF Type: Interactive (dynamic PDF).	FlexConfiguration
		SUBMITPDFTYPE_NONINTERACTIVE : String = "nonInteractive" [static] Submit PDF Type: (default) Non-interactive (non-interactive/flat PDF).	FlexConfiguration

Property Detail

applicationTimeOut

property

applicationTimeOut:int

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Application Idle time out in seconds

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 applicationTimeOut():int
public function set applicationTimeOut(value:int):void

appVersion

property

appVersion:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

CM Version 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 appVersion():String
public function set appVersion(value:String):void

assetNameCharset

property

assetNameCharset:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Set of characters that can be used for the name property of the editors

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 assetNameCharset():String
public function set assetNameCharset(value:String):void

authorInstance

property

authorInstance:Boolean

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

Boolean indicating wthether the server to which the client is connected is an Author Instance or Publish Instance;

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 authorInstance():Boolean
public function set authorInstance(value:Boolean):void

baseurl

property

baseurl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Fetches the Base URL for constructing outgoing URLs in the form of {protocol}://{server}[:{port}] with no trailing slash.

For example, if the server is being accessed over HTTP on localhost post 8080, the returned value would be http://localhost:8080.

Implementation
public function get baseurl():String

contentColor

property

contentColor:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The highlighting color to be applied on the selected Content (in Doc Composer).

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 contentColor():String
public function set contentColor(value:String):void

contentHighlightType

property

contentHighlightType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 10

Runtime Versions:

AIR (unsupported), Flash Player 10.2

The highlighting type to be done on the selected Content (in Doc Composer). Could be either 'border' or 'fill'

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 contentHighlightType():String
public function set contentHighlightType(value:String):void

contextUrl

property

contextUrl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Fetches the in-context URL: combination of {baseurl}/{pscmContext} that will never end with a slash.

Implementation
public function get contextUrl():String

exportDefinitionService

property

exportDefinitionService:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Export Definition service destination

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 exportDefinitionService():String
public function set exportDefinitionService(value:String):void

exportDefinitionServiceUrl

property

exportDefinitionServiceUrl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Fetches the Export Dependencies Service URL: combination of {baseurl}/{pscmContext}/{exportDefinitionService} that will never end with a slash.

Implementation
public function get exportDefinitionServiceUrl():String

exportDependenciesService

property

exportDependenciesService:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

ExportDependencies service destination within context root: {baseurl}/{pscmContext}/{exportDependencies}.

Warning: This is an externally-configurable value; it may or may not have leading/trailing slashes.

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 exportDependenciesService():String
public function set exportDependenciesService(value:String):void

Related API Elements

The base URL for the Render Service.
The context within the base URL where ICC apps and services are located.

property

loginMode:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

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 loginMode():String
public function set loginMode(value:String):void

pscmContext

property

pscmContext:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Context root specifying where ICC apps and services are located within the base URL: {baseurl}/{pscmContext}.

Warning: This is an externally-configurable value; it may or may not have leading/trailing slashes.

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 pscmContext():String
public function set pscmContext(value:String):void

Related API Elements

The base URL for all ICC apps and services.

renderParamFile

property

renderParamFile:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Render Service: URL parameter for requesting a file (actual bytes) once the file has been rendered: {renderServiceUrl}?{renderParamFile}={fileName}.

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 renderParamFile():String
public function set renderParamFile(value:String):void

renderService

property

renderService:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Render Service destination within context root: {baseurl}/{pscmContext}/{renderService}.

Warning: This is an externally-configurable value; it may or may not have leading/trailing slashes.

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 renderService():String
public function set renderService(value:String):void

Related API Elements

The base URL for the Render Service.
The context within the base URL where ICC apps and services are located.

renderServiceUrl

property

renderServiceUrl:String [read-only]

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Fetches the Render Service URL: combination of {baseurl}/{pscmContext}/{renderService} that will never end with a slash.

Implementation
public function get renderServiceUrl():String

submitPdfType

property

submitPdfType:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Type of PDF to pass to the letter's post process. One of SUBMITPDFTYPE constants.

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 submitPdfType():String
public function set submitPdfType(value:String):void

submitService

property

submitService:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Submit Service destination within context root: {baseurl}/{pscmContext}/{submitService}.

Warning: This is an externally-configurable value; it may or may not have leading/trailing slashes.

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 submitService():String
public function set submitService(value:String):void

Related API Elements

The base URL for the Submit Service.
The context within the base URL where ICC apps and services are located.

property

tmpfolder:String

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Temporary folder for any kind of file operation.

Warning: This is an externally-configurable value; it may or may not have leading/trailing slashes.

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 tmpfolder():String
public function set tmpfolder(value:String):void

Constructor Detail

()

Constructor

public function FlexConfiguration()

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Constructor

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.

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.

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`.

setBaseUrl

()

method

public function setBaseUrl(vBaseUrl:String):void

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Explicitly set the baseUrl. This is useful for FlexUnit testcases.

Parameters

vBaseUrl:String — Base URL for the application.

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.

Constant Detail

LOGINMODE_BASIC

Constant

public static const LOGINMODE_BASIC:String = "basic"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

LOGINMODE_NOLOGIN

Constant

public static const LOGINMODE_NOLOGIN:String = "nologin"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

LOGINMODE_SSO

Constant

public static const LOGINMODE_SSO:String = "sso"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

SUBMITPDFTYPE_INTERACTIVE

Constant

public static const SUBMITPDFTYPE_INTERACTIVE:String = "interactive"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Submit PDF Type: Interactive (dynamic PDF).

SUBMITPDFTYPE_NONINTERACTIVE

Constant

public static const SUBMITPDFTYPE_NONINTERACTIVE:String = "nonInteractive"

Language Version:

ActionScript 3.0

Product Version:

Asset Composer Building Block 9.5

Runtime Versions:

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

Submit PDF Type: (default) Non-interactive (non-interactive/flat PDF).

com.adobe.consulting.pst.vo FlexConfiguration - AS3 Asset Composer		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples

FlexConfiguration - AS3 Asset Composer

Classes x

applicationTimeOut

appVersion

assetNameCharset

authorInstance

baseurl

contentColor

contentHighlightType

contextUrl

exportDefinitionService

exportDefinitionServiceUrl

exportDependenciesService

exportDependenciesServiceUrl

fieldColor

fieldHighlightType

formLocale

indent

loginMode

pscmContext

renderParamFile

renderService

renderServiceUrl

submitPdfType

submitService

submitServiceUrl

targetColor

targetHighlightType

tmpfolder