Packageorg.granite.tide.seam.framework
Classpublic class StatusMessages
InheritanceStatusMessages Inheritance flash.events.EventDispatcher
ImplementsIComponent

The StatusMessages component gives access to the current list of status messages.
The messages are either received from the server or added locally by the addMessage or addMessageToControl method.

The StatusMessages component is by default bound to the context with the name 'statusMessages'.
  • messages is an ArrayCollection of TideMessage that can be retrieved or bound from tideContext.statusMessages.messages.
  • keyedMessages is an Map of ArrayCollections of TideMessages that can be retrieved or bound from tideContext.statusMessages.keyedMessages.
  • These message lists are bindable properties that can be used as providers for Repeaters or Lists.


    • Public Properties
     PropertyDefined by
      controlMessages : Object
    [read-only] Map of messages keyed by control id
    		StatusMessages
      messages : IList
    List of global messages
    		StatusMessages
      meta_name : String
    [read-only]
    		StatusMessages
    Public Methods
     MethodDefined by
      
    StatusMessages()
    		StatusMessages
      
    addMessage(severity:String, summary:String, details:String = ""):void
    Add a global message in the current list
    		StatusMessages
      
    addMessageToControl(controlId:String, severity:String, summary:String, details:String = ""):void
    Add a message in the current list of the specified control id
    		StatusMessages
      
    clearAllMessages():void
    Clear all messages (messages and control messages)
    		StatusMessages
      
    clearControlMessages():void
    Clear messages for all controls
    		StatusMessages
      
    clearMessages():void
    Clear global messages
    		StatusMessages
      
    clearMessagesForControl(controlId:String):void
    Clear messages for specified control
    		StatusMessages
      
    hasMessage():Boolean
    Return true is there is any available message
    		StatusMessages
      
    hasMessageForControl(controlId:String):Boolean
    Return true is there is any available message for the specified controlId
    		StatusMessages
      
    instance():StatusMessages
    [static]
    		StatusMessages
      
    meta_clear():void
    		StatusMessages
      
    meta_init(componentName:String, context:BaseContext):void
    		StatusMessages
    Property detail
    controlMessagesproperty
    controlMessages:Object  [read-only]

    Map of messages keyed by control id

    This property can be used as the source for data binding.

    Implementation
        public function get controlMessages():Object
    messagesproperty 
    messages:IList  [read-write]

    List of global messages

    This property can be used as the source for data binding.

    Implementation
        public function get messages():IList
        public function set messages(value:IList):void
    meta_nameproperty 
    meta_name:String  [read-only]

    This property can be used as the source for data binding.

    Implementation
        public function get meta_name():String
    Constructor detail
    StatusMessages()constructor
    public function StatusMessages()
    Method detail
    addMessage()method
    public function addMessage(severity:String, summary:String, details:String = ""):void

    Add a global message in the current list

    Parameters
    severity:String — severity
     
    summary:String — summary
     
    details:String (default = "") — details
    addMessageToControl()method 
    public function addMessageToControl(controlId:String, severity:String, summary:String, details:String = ""):void

    Add a message in the current list of the specified control id

    Parameters
    controlId:String — control id
     
    severity:String — severity
     
    summary:String — summary
     
    details:String (default = "") — details
    clearAllMessages()method 
    public function clearAllMessages():void

    Clear all messages (messages and control messages)

    clearControlMessages()method 
    public function clearControlMessages():void

    Clear messages for all controls

    clearMessages()method 
    public function clearMessages():void

    Clear global messages

    clearMessagesForControl()method 
    public function clearMessagesForControl(controlId:String):void

    Clear messages for specified control

    Parameters
    controlId:String — control id
    hasMessage()method 
    public function hasMessage():Boolean

    Return true is there is any available message

    Returns
    Boolean — true is at least one global message
    hasMessageForControl()method 
    public function hasMessageForControl(controlId:String):Boolean

    Return true is there is any available message for the specified controlId

    Parameters
    controlId:String

    Returns
    Boolean — true is at least one message
    instance()method 
    public static function instance():StatusMessages

    Returns
    StatusMessages
    meta_clear()method 
    public function meta_clear():void
    meta_init()method 
    public function meta_init(componentName:String, context:BaseContext):voidParameters
    componentName:String
     
    context:BaseContext