| 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 1.0, Flash Player 9, Flash Player 10 |
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
| appVersion : String Correspondence Management Solution Accelerator version string. | FlexConfiguration | ||
| assetNameCharset : String
Specifies the list of Unicode character ranges permitted in an asset name. | FlexConfiguration | ||
| baseurl : String [read-only]
Specifies the base URL for constructing outgoing URLs in the format {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 | |
| contextUrl : String [read-only]
Specifies the in-context URL, which uses the format {baseurl}/{pscmContext} and never ends with a slash. | FlexConfiguration | ||
| exportDefinitionService : String
ExportDefinition service destination within context root: {baseurl}/{pscmContext}/{exportDefinition}. | FlexConfiguration | ||
| exportDefinitionServiceUrl : String [read-only] The Export Definition Service URL: combination of {baseurl}/{pscmContext}/{exportDefinitionService} that will never end with a slash. | FlexConfiguration | ||
| exportDependenciesService : String
Specifies the ExportDependencies service destination within the context root:
{baseurl}/{pscmContext}/{exportDependencies}. | FlexConfiguration | ||
| exportDependenciesServiceUrl : String [read-only] The Export Dependencies Service URL, which uses the format
{baseurl}/{pscmContext}/{exportDependenciesService} and never ends with a slash. | FlexConfiguration | ||
| formLocale : String
Specifies the locale the Flex application uses to initialize itself. | FlexConfiguration | ||
| indent : Number The indentation value to apply when indenting modules in a target. | FlexConfiguration | ||
| loginMode : String Specifies how Flex applications log in to User Management. | FlexConfiguration | ||
| optimizeDDI : Boolean
Optimize Data Dictionary Instance Size and transfer
| FlexConfiguration | ||
| pscmContext : String
Specifies the context root where Correspondence Management Solution Accelerator applications and services are located within the base URL: {baseurl}/{pscmContext}. | FlexConfiguration | ||
| renderParamFile : String
Specifies the URL parameter for requesting a file once the file is rendered:
{renderServiceUrl}?{renderParamFile}={fileName}. | FlexConfiguration | ||
| renderService : String
Specifies the render service destination within the context root: {baseurl}/{pscmContext}/{renderService}. | FlexConfiguration | ||
| renderServiceUrl : String [read-only]
Specifies the render service URL, which is uses the format {baseurl}/{pscmContext}/{renderService} and never ends with a slash. | FlexConfiguration | ||
| showFragmentTab : Boolean
Specifies visibility of Fragments Tab in Letter Editor (Fragment Table Support in CM 2.5)
| FlexConfiguration | ||
| showPDFToolbar : Boolean True if the PDF Toolbar should be shown in Composer. | FlexConfiguration | ||
| submitPdfType : String Specifies the PDF type of the letter. | FlexConfiguration | ||
| submitService : String
Specifies the submit service destination within the context root: {baseurl}/{pscmContext}/{submitService}. | FlexConfiguration | ||
| submitServiceUrl : String [read-only]
Specifies the submit service URL, which uses the format {baseurl}/{pscmContext}/{submitService} and never ends with a slash. | FlexConfiguration | ||
| tmpfolder : String
Specifies a temporary folder for any kind of file operation. | FlexConfiguration | ||
| Method | Defined By | ||
|---|---|---|---|
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 | ||
Dispatches an event into the event flow. | FlexConfiguration | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | FlexConfiguration | ||
|
Indicates whether an object has a specified property defined. | Object | |
|
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. | FlexConfiguration | ||
Explicitly sets the base URL. | FlexConfiguration | ||
|
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. | FlexConfiguration | ||
| Constant | Defined By | ||
|---|---|---|---|
| LOGINMODE_BASIC : String = "basic" [static]
Specifies the login mode when basic backend authentication is required. | FlexConfiguration | ||
| LOGINMODE_NOLOGIN : String = "nologin" [static]
Specifies the login mode when no login is required. | FlexConfiguration | ||
| LOGINMODE_SSO : String = "sso" [static]
Specifies the login mode when User Manager single sign-on is used. | FlexConfiguration | ||
| SUBMITPDFTYPE_INTERACTIVE : String = "interactive" [static]
Specifies the submit PDF type when the type is interactive. | FlexConfiguration | ||
| SUBMITPDFTYPE_NONINTERACTIVE : String = "nonInteractive" [static]
Specifies the submit PDF type when the type is non-interactive. | FlexConfiguration | ||
appVersion | property |
appVersion: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 |
Correspondence Management Solution Accelerator 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):voidassetNameCharset | property |
assetNameCharset: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 |
Specifies the list of Unicode character ranges permitted in an asset name.
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):voidbaseurl | property |
baseurl:String [read-only] | 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 base URL for constructing outgoing URLs in the format {protocol}://{server}[:{port}], with no trailing slash.
For example, if the server is accessed over HTTP on localhost port 8080, the returned value is http://localhost:8080.
Implementation
public function get baseurl():StringcontextUrl | property |
contextUrl:String [read-only] | 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 in-context URL, which uses the format {baseurl}/{pscmContext} and never ends with a slash.
Implementation
public function get contextUrl():StringexportDefinitionService | property |
exportDefinitionService: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 |
ExportDefinition service destination within context root: {baseurl}/{pscmContext}/{exportDefinition}.
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 exportDefinitionService():String public function set exportDefinitionService(value:String):voidRelated API Elements
exportDefinitionServiceUrl | property |
exportDefinitionServiceUrl:String [read-only] | 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 Export Definition Service URL: combination of {baseurl}/{pscmContext}/{exportDefinitionService} that will never end with a slash.
Implementation
public function get exportDefinitionServiceUrl():StringexportDependenciesService | property |
exportDependenciesService: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 |
Specifies the ExportDependencies service destination within the context root:
{baseurl}/{pscmContext}/{exportDependencies}.
Warning: This is an externally-configurable value. It may or may not have leading or 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):voidRelated API Elements
exportDependenciesServiceUrl | property |
exportDependenciesServiceUrl:String [read-only] | 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 Export Dependencies Service URL, which uses the format
{baseurl}/{pscmContext}/{exportDependenciesService} and never ends with a slash.
Implementation
public function get exportDependenciesServiceUrl():StringformLocale | property |
formLocale: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 |
Specifies the locale the Flex application uses to initialize itself.
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 formLocale():String public function set formLocale(value:String):voidindent | property |
indent:NumberThe indentation value to apply when indenting modules in a target. That is, in a document composer application.
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 indent():Number public function set indent(value:Number):voidloginMode | property |
loginMode: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 |
Specifies how Flex applications log in to User Management. One of the LOGINMODE 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 loginMode():String public function set loginMode(value:String):voidoptimizeDDI | property |
optimizeDDI:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Asset Composer Building Block 9.5 |
| Runtime Versions: | AIR (unsupported), Flash Player 10.2 |
Optimize Data Dictionary Instance Size and transfer
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 optimizeDDI():Boolean public function set optimizeDDI(value:Boolean):voidpscmContext | property |
pscmContext: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 |
Specifies the context root where Correspondence Management Solution Accelerator applications and services are located within the base URL: {baseurl}/{pscmContext}.
Warning: This is an externally-configurable value. It may or may not have leading or 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):voidRelated API Elements
renderParamFile | property |
renderParamFile: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 |
Specifies the URL parameter for requesting a file once the file is rendered:
{renderServiceUrl}?{renderParamFile}={fileName}. This request is for the actual bytes. Used with the render service.
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):voidrenderService | property |
renderService: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 |
Specifies the render service destination within the context root: {baseurl}/{pscmContext}/{renderService}.
Warning: This is an externally-configurable value. It may or may not have leading or 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):voidRelated API Elements
renderServiceUrl | property |
renderServiceUrl:String [read-only] | 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 render service URL, which is uses the format {baseurl}/{pscmContext}/{renderService} and never ends with a slash.
Implementation
public function get renderServiceUrl():StringshowFragmentTab | property |
showFragmentTab:Boolean| 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 visibility of Fragments Tab in Letter Editor (Fragment Table Support in CM 2.5)
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 showFragmentTab():Boolean public function set showFragmentTab(value:Boolean):voidshowPDFToolbar | property |
showPDFToolbar:BooleanTrue if the PDF Toolbar should be shown in Composer. Can be overriden by the DC URL parameter 'cmPDFToolbar'
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 showPDFToolbar():Boolean public function set showPDFToolbar(value:Boolean):voidsubmitPdfType | property |
submitPdfType: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 |
Specifies the PDF type of the letter. The type field is required for post-processing and is one of the 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):voidsubmitService | property |
submitService: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 |
Specifies the submit service destination within the context root: {baseurl}/{pscmContext}/{submitService}.
Warning: This is an externally-configurable value. It may or may not have leading or 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):voidRelated API Elements
submitServiceUrl | property |
submitServiceUrl:String [read-only] | 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 submit service URL, which uses the format {baseurl}/{pscmContext}/{submitService} and never ends with a slash.
Implementation
public function get submitServiceUrl():Stringtmpfolder | property |
tmpfolder: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 |
Specifies a temporary folder for any kind of file operation.
Warning: This is an externally-configurable value. It may or may not have leading or 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):voidFlexConfiguration | () | Constructor |
public function FlexConfiguration()| 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.
addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):voidRegisters 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:
| |
useCapture:Boolean (default = false)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) | |
weakRef:Boolean (default = false)Class-level member functions are not subject to garbage
collection, so you can set |
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.
|
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.
|
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):voidRemoves 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)removeEventListener() are required to remove both: one call with useCapture set to true, and another call with useCapture set to false.
|
setBaseUrl | () | method |
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.
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.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
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 1.0, Flash Player 9, Flash Player 10 |
Specifies the login mode when basic backend authentication is required. For example, authentication that requires a username and password.
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 1.0, Flash Player 9, Flash Player 10 |
Specifies the login mode when no login is required.
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 1.0, Flash Player 9, Flash Player 10 |
Specifies the login mode when User Manager single sign-on is used.
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 1.0, Flash Player 9, Flash Player 10 |
Specifies the submit PDF type when the type is interactive. That is, 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 1.0, Flash Player 9, Flash Player 10 |
Specifies the submit PDF type when the type is non-interactive. That is, a flat PDF. This is the default value.
Wed Nov 21 2018, 06:34 AM -08:00