<a:PrivateHyperlink>

This component is for internal (platform/ui) use only. All application developers should use AWHyperlink. Eventually, we will rework AWHyperlink to be more efficient, but we do not want people to build in dependencies on this api.

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	By default, PrivateHyperlink will detect if its used within a form and will submit. Otherwise this is a normal hyperlink that performs a GET. To prevent form submission (eg for implementing a Cancel operation), use this binding and return true.	boolean (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)
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)

ariba.ui.aribaweb.html
Class AWPrivateHyperlink

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

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public final class AWPrivateHyperlink
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

AWPrivateHyperlink()

Method Summary

boolean	isStateless() Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e.
AWResponseGenerating	linkClicked()
boolean	omitTags()
boolean	submitForm()
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, 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, 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

_actionBinding

public AWBinding _actionBinding

_pageNameBinding

public AWBinding _pageNameBinding

_submitFormBinding

public AWBinding _submitFormBinding

_targetBinding

public AWBinding _targetBinding

_omitTagsBinding

public AWBinding _omitTagsBinding

_namePrefixBinding

public AWBinding _namePrefixBinding

Constructor Detail

AWPrivateHyperlink

public AWPrivateHyperlink()

Method Detail

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

isStateless

public boolean isStateless()

Description copied from class: AWComponent

Overridden by AWComponent subclasses to indicate whether component instances should be preserved with the page/session (i.e. are "stateful") or can be pooled and reused for each phase of request processing (i.e. are stateless) Default is to be stateless unless the component is used as the top-level (page) component.

Overrides:

isStateless in class AWComponent

submitForm

public boolean submitForm()

linkClicked

public AWResponseGenerating linkClicked()

omitTags

public boolean omitTags()