Class f_messageContext

Object
  f_object
      f_messageContext

public final class f_messageContext
extends f_object

Class Message Context

Field Summary

static any	ADD_MESSAGE_EVENT_TYPE
static any	CLEAR_MESSAGES_EVENT_TYPE
static any	POST_CHECK_EVENT_TYPE

Method Summary

static f_messageContext	Get(HTMLElement component)
static f_messageObject[]	ListMessages(HTMLElement component)
f_messageObject	f_addMessage(HTMLElement component, Number severity, String summary, String detail)
boolean	f_clearMessages(HTMLElement... component)
boolean	f_containsMessagesFor(String componentId)
Number	f_getStopSeverity()
String[]	f_listComponentIdsWithMessages(any withComponentOnly)
f_messageObject[]	f_listMessages(String componentId, any globalOnly)
void	f_setStopSeverity(Number level)
String	toString() Returns a string representing the specified object.

Methods inherited from class f_object

f_getClass, toString

Methods inherited from class Object

toString

Field Detail

ADD_MESSAGE_EVENT_TYPE

public static final any ADD_MESSAGE_EVENT_TYPE

CLEAR_MESSAGES_EVENT_TYPE

public static final any CLEAR_MESSAGES_EVENT_TYPE

POST_CHECK_EVENT_TYPE

public static final any POST_CHECK_EVENT_TYPE

Method Detail

f_listMessages

public f_messageObject[] f_listMessages(String componentId,
                                        any globalOnly)

Parameters:

componentId - Identifiant of component, or an array of identifiants. (null specified ALL messages)

Returns:

Boolean globalOnly

f_clearMessages

public boolean f_clearMessages(HTMLElement... component)

Parameters:

component - (or an id)

Returns:

Returns true if some messages have been removed.

ListMessages

public static f_messageObject[] ListMessages(HTMLElement component)

Parameters:

component - A component or an event object.

f_getStopSeverity

public Number f_getStopSeverity()

Returns:

The level of severity

See Also:

f_messageObject#SEVERITY_INFO, f_messageObject#SEVERITY_WARN, f_messageObject#SEVERITY_ERROR, f_messageObject#SEVERITY_FATAL

f_addMessage

public f_messageObject f_addMessage(HTMLElement component,
                                    Number severity,
                                    String summary,
                                    String detail)

Parameters:

component - Component to add the message, or an array of components.

severity -

summary -

detail -

f_containsMessagesFor

public boolean f_containsMessagesFor(String componentId)

Parameters:

componentId - Identifiant of component, or an array of identifiants. (null specified ALL messages)

f_listComponentIdsWithMessages

public String[] f_listComponentIdsWithMessages(any withComponentOnly)

Returns:

Boolean withComponentOnly to return only messages associated to a component

f_setStopSeverity

public void f_setStopSeverity(Number level)

Parameters:

level - Level of severity

See Also:

f_messageObject#SEVERITY_INFO, f_messageObject#SEVERITY_WARN, f_messageObject#SEVERITY_ERROR, f_messageObject#SEVERITY_FATAL

toString

public String toString()

Description copied from class: Object

Returns a string representing the specified object.

Overrides:

toString in class f_object

Get

public static f_messageContext Get(HTMLElement component)

Parameters:

component - A component or an event object.