<a:Hyperlink>

Provides for a standard Html hyperlink. AWHyperlink may be wrapped around anything that a normal <a/> tag could be around. Allows for binding and action or specifying a pageName so that when the user clicks, the action is fired or the named page is displayed. Optionally, you may use AWHyperlink to submit a form. Bindings which are not mentioned belowed may be passed-though to the opening <a/> as arbitrary attributes in the html tag.

Bindings

action	Will be evaluated when the invokeAction phase detects that the hyperlink was clicked. A value of null should be returned to cycle the current page. Note: it is recommended that you declare your return type to be either AWComponent or AWResponse, unless you cannot be sure because you are deferring to another method for the action.	AWResponseGenerating (get)
pageName	In the event you don't need to do anything to setup the state for the returned page, this may be more convenient than 'action' since you don't need to write any java code. This will be evaluated during the invokeAction phase in order to get the name of the page to create and return.	String (get)
submitForm	Allows for submitting the form in which the hyperlink is defined. If specified and evaluates to true, javascript will be used to submit the enclosing form. Do not use onClick with AWHyperlink along with submitForm. [In fact, its generally a bad idea to use javascript with any awf components as it conflicts with intenal implementation.]	boolean (get)
onClick	As long as submitForm is false, you may associate an onClick with the AWHyperlink, but it is strongly discouraged. It would be better to use an AWGenericContainer and build your own at that point.	string (get)
omitTags	Allows for not rendering the opening/closing tags of the . This makes it easy to avoid duplicating the body of the hyperlink just to turn off the link itself. If true, only the body is rendered. Since, the tags are not rendered, the user cannot click the link so none of the bindings which would apply then have any effect.	boolean (get)
senderId	Allows for providing your own senderId (eg to allow for human readable senderid). It is strongly recommended that this not be used as the system cannot guarantee proper results if used incorrectly.	String (get)
href	Provide your own href. Rather than use this, you should consider using a GenericContainer and making your own.	String (get)
scrollToVisible	When the link is clicked and the page cycled (same page returned), it will attempt to scroll the page to where the link is at the top of the page.	boolean (get)
target	If provided, will put a target attribute in the tag so the browser will open the returned page in this new window. This is not recommened for nor application usage as multi-window apps are problematic. In any case, we do maintain a separate page cache for newly created windows, so this will also place the returned page in that separate page cache.	String (get)
windowAttributes	If the target binding is used, you may specify the window attributes with this binding. See book on html/javascript and look for window.open(...) for details.	String (get)
fragmentIdentifier	If specified, must be the name of another anchor tag on the destination page so the browser can scroll to that link.	String (get)
onMouseDown	Not supported?	String (get)
behavior		String (get)

ariba.ui.aribaweb.html
Class AWHyperlink

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.aribaweb.html.AWHyperlink

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

Direct Known Subclasses:

ConfirmationLink

public class AWHyperlink
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

AWHyperlink()

Method Summary

AWEncodedString	frameName()
AWEncodedString	hrefString()
AWResponseGenerating	invokeAction()
boolean	isHiddenFieldSender()
boolean	isSender()
boolean	omitLink()
AWStringDictionary	otherBindingsValues()
java.lang.String	remoteLinkUrl()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
AWEncodedString	senderId()
boolean	staticOrOmit()
java.lang.String	staticUrlForActionResults()
java.lang.String[]	supportedBindingNames()

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, 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, 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

_elementId

public AWEncodedString _elementId

_senderId

public AWEncodedString _senderId

_isSubmitForm

public boolean _isSubmitForm

_actionBinding

public AWBinding _actionBinding

_pageNameBinding

public AWBinding _pageNameBinding

_onClickBinding

public AWBinding _onClickBinding

_omitTagsBinding

public AWBinding _omitTagsBinding

_fragmentIdentifierBinding

public AWBinding _fragmentIdentifierBinding

_targetBinding

public AWBinding _targetBinding

_scrollToVisibleBinding

public AWBinding _scrollToVisibleBinding

_senderIdBinding

public AWBinding _senderIdBinding

_hrefBinding

public AWBinding _hrefBinding

_submitFormBinding

public AWBinding _submitFormBinding

Constructor Detail

AWHyperlink

public AWHyperlink()

Method Detail

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

frameName

public AWEncodedString frameName()

otherBindingsValues

public AWStringDictionary otherBindingsValues()

Overrides:

otherBindingsValues in class AWComponent

hrefString

public AWEncodedString hrefString()

remoteLinkUrl

public java.lang.String remoteLinkUrl()

isHiddenFieldSender

public boolean isHiddenFieldSender()

invokeAction

public AWResponseGenerating invokeAction()

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 AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

senderId

public AWEncodedString senderId()

isSender

public boolean isSender()

staticOrOmit

public boolean staticOrOmit()

staticUrlForActionResults

public java.lang.String staticUrlForActionResults()

omitLink

public boolean omitLink()