<w:MessagesList>

Widget used to display a set of messages

Bindings

message	The message may either be a list of errors or a single error. Each message may be a String or an Object, which will be toString'ed for display. If the message is a String it can either be an already-localed String or can be an NLSString of the form @resource/key, in which case we'll translate it.	?? (get)
isError	Indicates whether the messages "errors". If true we use the "error" icon and prepend the messages with "Error: ". If neither isAlert nor isConfirmation is true, then isError is automatically set to true.	boolean (get)
isWarning	Indicates whether the messages are "warnings". If true we use the "alert" icon and prepend the messages with "Alert: ". Note that isError takes precendence on isWarning, meaning if isError is true then isWarning is assumed to be false.	boolean (get)
isConfirmation	Indicates whether the messages are "confirmations". If true we use the "confirm" icon and prepend the messages with "Confirmation: ". Note that isError takes precendence on isConfirmation, meaning if isError is true then isConfirmation is assumed to be false.	boolean (get)
addExtraBR	Indicates whether the list of messages should be between two line breaks.	boolean (get)

ariba.ui.widgets
Class MessagesList

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.widgets.MessagesList

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public class MessagesList
extends AWComponent

Displays a list of messages using the style appropriate according to its severity.

    Required bindings:

       none
    

    Optional bindings:

        message: Either a vector of messages or a single message. Each
        message may be a String or an Object, which will be toString'ed for
        display.  If the message is a String it can either be an
        already-localed String or can be an NLSString of the form
        "@resource/key", in which case we'll translate it.

        isError:        indicates whether the message are "errors". By default true.
        isWarning:      indicates whether the message are "alerts". By default false.
                        If isError is true, this parameter is ignored.
        isConfirmation: indicates whether the message are "confirmations". By default false.
                        If isError or isWarning is true, this parameter is ignored.
                        Example of confirmation message: "Your password has been successfully updated."
    

Nested Class Summary

Nested classes/interfaces inherited from class ariba.ui.aribaweb.core.AWComponent

AWComponent.RenderingFilter, AWComponent.RenderingListener

Nested classes/interfaces inherited from interface ariba.ui.aribaweb.core.AWResponseGenerating

AWResponseGenerating.ResponseSubstitution

Constructor Summary

MessagesList()

Method Summary

boolean	hasMessage() Returns true if we have some error messages.
java.util.List	message() Returns a vector of localized message strings.
void	sleep() Overridden to clean up cached values.
java.lang.String	style() Returns the style to use to display the message.

Methods inherited from class ariba.ui.aribaweb.core.AWComponent

_topLevelApplyValues, _topLevelInvokeAction, _topLevelRenderResponse, allowEmbeddedKeyPaths, allowsWhitespaceCompression, application, applyValues, awcyclePageAndLog, bindingForName, bindingForName, bindings, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browserMaxWidth, browserMinWidth, characterEncoding, clearValidationError, clientTimeZone, componentConfiguration, componentDefinition, componentPath, componentReference, createPageWithName, defaultTemplateParser, determineInstance, determineInstance, dict, dict, dict, doubleValueForBinding, doubleValueForBinding, doubleValueForBinding, encodedStringValueForBinding, encodedStringValueForBinding, ensureAwake, ensureFieldValuesClear, env, errorManager, escapeAttribute, escapeString, escapeUnsafeString, extendedFields, formValueManager, generateResponse, generateResponse, generateResponse, generateStringContents, getAWParameter, getDrivingBusinessObject, getFoldInSituOnWindowSizeParam, getPageRenderVersion, getThis, hasBinding, hasBinding, hasContentForTagName, hasContentNamed, hasMultipleTemplates, hasSubTemplateNamed, httpSession, init, init, initTemplateResourceManager, intValueForBinding, intValueForBinding, intValueForBinding, invokeAction, isBidirectional, isBrowserMicrosoft, isClientPanel, isMacintosh, isRenderAW5, isStateless, isStrictTagNaming, isUserCommunityEnabled, isValidationEnabled, languageDirection, languageLeft, languageRight, loadTemplate, localizedJavaString, markBacktrackState, name, namePath, notifyChange, otherBindings, otherBindingsValues, page, pageComponent, pageWithClass, pageWithClass, pageWithName, pageWithName, parent, postTakeValueActions, preferredLocale, recordBacktrackState, recordBacktrackState, recordValidationError, recordValidationError, recordValidationError, recordValidationErrors, recordValidationWarning, redirectToPage, registerRenderingListener, registerXmlNodeWithName, removeBacktrackState, renderResponse, replacementResponse, request, requestContext, requiresPreGlidCompatibility, resourceClassName, resourceManager, response, restoreFromBacktrackState, session, session, setCharacterEncoding, setClientPanel, setClientTimeZone, setComponentConfiguration, setDefaultTemplateParser, setEnv, setPerfDestinationInfo, setPreferredLocale, setResourceManager, setTemplateParser, setupForNextCycle, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, setValueForBinding, shouldCachePage, shouldCloseElements, strings, stringValueForBinding, stringValueForBinding, stringValueForBinding, supportedBindingNames, template, templateName, templateParser, templateResource, templateResourceManager, truncateBacktrackState, truncateBacktrackState, urlForResourceNamed, urlForResourceNamed, urlForResourceNamed, useXmlEscaping, valueForBinding, valueForBinding, valueForBinding, xml

Methods inherited from class ariba.ui.aribaweb.util.AWBaseObject

debugString, getFieldValue, isKindOfClass, localizedJavaString, logString, logWarning, setFieldValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ariba.ui.aribaweb.util.AWObject

getFieldValue, isKindOfClass, setFieldValue

Constructor Detail

MessagesList

public MessagesList()

Method Detail

sleep

public void sleep()

Overridden to clean up cached values.

hasMessage

public boolean hasMessage()

Returns true if we have some error messages.

message

public java.util.List message()

Returns a vector of localized message strings.

style

public java.lang.String style()

Returns the style to use to display the message.