<w:ErrorIndicator>

This is the compact display for errors and required fields. A red asterisk is displayed to indicate there is error, blue asterisk for requireness, and yellow for warning. When the user hovers over the red asterisk, a bubble pops up to show the actual error message.

Bindings
errorKey

An object that identifies the error that is being displayed by this component. One of errorKey or errorValueSource must be specified.

Object
(get)
errorValueSource

The value source part of the identifier of the error that is being displayed by this component. One of errorKey or errorValueSource must be specified.

Object
(get)
errorFieldPath

The field path part of the identifier of the error that is being displayed by this component.

Object
(get)
errorGroupName

The group name part of the identifier of the error that is being displayed by this component.

Object
(get)
showError

True if errors should be displayed when there are errors.

boolean
(get)
showWarning

True if warnings should be displayed when there are warnings.

boolean
(get)
showRequired

True if a "required" indicator should be displayed.

boolean
(get)
autoHideBubble

True if the error bubble should be popped down automatically on a timer.

boolean
(get)
errorImage

Specify a custom image as the indicator for errors in the display.

String
(get)
warningImage

Specify a custom image as the indicator for warnings in the display.

String
(get)
isNavigable

When set to false, this error indicator is skipped over during error navigation. An indicator is still displayed even when isNavigable is false, and mouse over will pop up the error bubble.

boolean
(get)

Named Content
customBubbleContent

Define content to display in the bubble, in addition to the error msg.

ariba.ui.widgets
Class ErrorIndicator

java.lang.Object
  extended by ariba.ui.aribaweb.util.AWBaseObject
      extended by ariba.ui.aribaweb.core.AWComponent
          extended by ariba.ui.widgets.ErrorFlag
              extended by ariba.ui.widgets.ErrorIndicator
All Implemented Interfaces:
AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public class ErrorIndicator
extends ErrorFlag


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
ErrorIndicator()
           
 
Method Summary
 boolean autoHideBubble()
           
 AWEncodedString customContentDivId()
           
 java.lang.String errorOrWarning()
           
 java.util.List getErrorMessages()
           
 boolean hasMultipleErrors()
           
 java.lang.String hideBubbleScript()
           
 AWEncodedString indicatorId()
           
 boolean isHighLightedError()
           
 boolean pageAutoScroll()
          This will indicate if the page should be auto-scrolled or not.
 void renderResponse(AWRequestContext requestContext, AWComponent component)
          The receiver should render its content to the AWRequestContext.response()
 java.lang.String showBubbleScript()
           
 boolean showRequired()
           
 
Methods inherited from class ariba.ui.widgets.ErrorFlag
error, hasErrorsOrWarnings, isGeneralError, showError, showWarning, warning
 
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, 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
 

Field Detail

_customContentDivId

public AWEncodedString _customContentDivId

_errorContentDivId

public AWEncodedString _errorContentDivId

curItem

public java.lang.String curItem
Constructor Detail

ErrorIndicator

public ErrorIndicator()
Method Detail

renderResponse

public void renderResponse(AWRequestContext requestContext,
                           AWComponent component)
Description copied from interface: AWCycleable
The receiver should render its content to the AWRequestContext.response()

Specified by:
renderResponse in interface AWCycleable
Overrides:
renderResponse in class ErrorFlag
Parameters:
requestContext - the context for the current request.
component - the current parent component

autoHideBubble

public boolean autoHideBubble()

pageAutoScroll

public boolean pageAutoScroll()
This will indicate if the page should be auto-scrolled or not. Note: this is a binding.

Returns:
Returns true unless scrolling is disabled or none of the table errors are visible in the table.

customContentDivId

public AWEncodedString customContentDivId()

indicatorId

public AWEncodedString indicatorId()
Overrides:
indicatorId in class ErrorFlag

showRequired

public boolean showRequired()

errorOrWarning

public java.lang.String errorOrWarning()

isHighLightedError

public boolean isHighLightedError()

hasMultipleErrors

public boolean hasMultipleErrors()

getErrorMessages

public java.util.List getErrorMessages()

showBubbleScript

public java.lang.String showBubbleScript()

hideBubbleScript

public java.lang.String hideBubbleScript()


AribaWeb User Interface Development Framework
Copyright © 2000-2014 Ariba, Inc. All Rights Reserved.