ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
lc.foundation.util 

CompositeMessage  - AS3 ADEP Workspace
Packagelc.foundation.util
Classpublic class CompositeMessage
InheritanceCompositeMessage Inheritance Message Inheritance 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 CompositeMessage class encapsulates a composite message. A composite message is a message that has nested messages. The general format is [top-level identifer]/[next level identifier]/.../[most specific identifer]. For example, the message identifier of such a message can be "ALC-WKS-123-456" or "ALC-XYZ-432-321" or "X754RT3". Most message identifiers are Workspace identifiers of the form ALC-XYZ-123-456; however, there may also be identifiers from other technologies and in different formats.

Use the CompositeMessage class for nested error messages.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheriteddate : Date
[read-only] The time the message was recorded at.
Message
  formattedMessage : String
[override] [read-only] The localized message text with all substitutions and is appropriately formatted for display.
CompositeMessage
 InheritedlogLevel : int
The logging level of the message.
Message
  messageId : String
[override] [read-only] The composite message identifier.
CompositeMessage
  nestedId : String
[read-only] The nested message identifier.
CompositeMessage
  rawMessage : String
[override] [read-only] The localized message text with all substitutions, but the text is not formatted with the standard UI formatting.
CompositeMessage
  topLevelId : String
[read-only] The top-level message identifier.
CompositeMessage
Public Methods
 MethodDefined By
  
CompositeMessage(id:String, nestedId:String, nestedMessage:String, params:Array)
Constructor.
CompositeMessage
 Inherited
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.
Message
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
Message
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Message
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
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
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
Message
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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.
Message
Property Detail

formattedMessage

property
formattedMessage:String  [read-only] [override]

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 localized message text with all substitutions and is appropriately formatted for display.



Implementation
    override public function get formattedMessage():String

messageId

property 
messageId:String  [read-only] [override]

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 composite message identifier. The returned string value is equivalent to retrieving the strings from the topLeveId and nestedId properties. The format of the string returned is topLevelId() + "/" + nestedId().



Implementation
    override public function get messageId():String

nestedId

property 
nestedId: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 nested message identifier.



Implementation
    public function get nestedId():String

rawMessage

property 
rawMessage:String  [read-only] [override]

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 localized message text with all substitutions, but the text is not formatted with the standard UI formatting.



Implementation
    override public function get rawMessage():String

topLevelId

property 
topLevelId: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 top-level message identifier.



Implementation
    public function get topLevelId():String
Constructor Detail

CompositeMessage

()Constructor
public function CompositeMessage(id:String, nestedId:String, nestedMessage:String, params:Array)

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.

Parameters
id:String — Specifies the message identifier.
 
nestedId:String — Specifies the nested message identifier.
 
nestedMessage:String — Specifies the nested message.
 
params:Array — Specifies an array of message parameters. These are substituted into the message.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy