<w:CueTip>

Usage:

<w:CueTip value="$value"/>

or

<w:CueTip>My cue tip string</w:CueTip>

The tip string passed as a value binding

<w:CueTip value="$value"/>

In this usage, the value binding is used as the tip string. The value binding is parsed and verified for "safeHTML" as defined by the "escapeUnsafeHtml" binding in AWString. As a convenience, "\n" is converted to a <br/> before rendering.

By default, a CueTip is automatically sized based on the current window size. Autosizing occurs irrespective of any HTML content in the value string or in the component content. This allows the <b></b> and <i></i> tags to be used in conjunction with autosizing.

If explicit formatting is desired, the autoSize binding can be set to $false. Alternatively for the string passed in via the "value" binding can be wrapped by <html></html> which will disable autosizing of the tip dialog. In this case the sizing of the tip dialog is the responsibility of the user (for example, the tip string can contain <br/> and <p/> tags).

For ease of translation, most developers should use the value binding method and not include any HTML in the tip string.

Bindings
value

String content used as CueTip content. This string value will be passed through the AWString escapeUnsafeHtml parser so only "safe" HTML will be allowed. All other HTML will be escaped. See AWString for more information.

If no value binding is passed in then the component content is used as the value for the CueTip.

String
(get)
autoSize

Determines whether or not the CueTip is automatically sized. True by default.

boolean
(get)

ariba.ui.widgets
Class CueTip

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

public final class CueTip
extends AWComponent


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
CueTip()
           
 
Method Summary
 java.lang.String getOnDisplayHandler()
           
 java.lang.String getStyle()
           
 java.lang.String getValue()
           
 boolean isManualFormatting()
           
static void setState(AWRequestContext requestContext, boolean state)
           
 
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
 

Field Detail

PreferenceKey

public static final java.lang.String PreferenceKey
See Also:
Constant Field Values

AutoSizeKey

public static final java.lang.String AutoSizeKey
See Also:
Constant Field Values

_menuId

public AWEncodedString _menuId

_divId

public java.lang.String _divId

_visible

public boolean _visible

_value

public java.lang.String _value

_isManualFormatting

public boolean _isManualFormatting

StartHTMLIndicator

public static final java.lang.String StartHTMLIndicator
See Also:
Constant Field Values

EndHTMLIndicator

public static final java.lang.String EndHTMLIndicator
See Also:
Constant Field Values
Constructor Detail

CueTip

public CueTip()
Method Detail

getValue

public java.lang.String getValue()

isManualFormatting

public boolean isManualFormatting()

getStyle

public java.lang.String getStyle()

getOnDisplayHandler

public java.lang.String getOnDisplayHandler()

setState

public static final void setState(AWRequestContext requestContext,
                                  boolean state)


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