Packagelc.core
Classpublic class CompositeMessage
InheritanceCompositeMessage Inheritance Message Inheritance Object

The CompositeMessage class encapsulates a composite message. A composite message is a message with that has nested messages. The general format is [top-level identifer]/[next level identifier]/.../[most specific identifier]. 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 will be LiveCycle Workspace ES identifiers of the form ALC-XYZ-123-456; however, there may also be identifiers from other technologies and in different formats.

You 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
  formattedMessage : String
[read-only] Retrieves the localized message text with all substitutions and is appropriately formatted for display.
CompositeMessage
 InheritedlogLevel : int
Retrieves the logging level of the message.
Message
  messageId : String
[read-only] Thee composite message identifier.
CompositeMessage
  nestedId : String
[read-only] Retrieves the nested message identifier.
CompositeMessage
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  rawMessage : String
[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] Retrieves the top-level message identifier.
CompositeMessage
Public Methods
 MethodDefined By
  
CompositeMessage(id:String, nestedId:String, nestedMessage:String, params:Array)
Constructor.
CompositeMessage
 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
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
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
Property Detail
formattedMessageproperty
formattedMessage:String  [read-only]

Retrieves the localized message text with all substitutions and is appropriately formatted for display.


Implementation
    public function get formattedMessage():String
messageIdproperty 
messageId:String  [read-only]

Thee composite message identifier. The string that is returned is equivalent to retrieving the strings from the topLeveId and nestedId methods. The format of the string returned is topLevelId() + "/" + nestedId().


Implementation
    public function get messageId():String
nestedIdproperty 
nestedId:String  [read-only]

Retrieves the nested message identifier.


Implementation
    public function get nestedId():String
rawMessageproperty 
rawMessage:String  [read-only]

The localized message text with all substitutions, but the text is not formatted with the standard UI formatting.


Implementation
    public function get rawMessage():String
topLevelIdproperty 
topLevelId:String  [read-only]

Retrieves 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)

Constructor.

Parameters
id:String — The message identifier.
 
nestedId:String — The nested message identifier.
 
nestedMessage:String — The nested message.
 
params:Array — The message parameters. These will be substituted into the message.



© 2004-2007 Adobe Systems Incorporated. All rights reserved.
Sun Sep 23 2007, 10:15 PM GMT-07:00

 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/core/CompositeMessage.html