<w:HTMLActionFilter>

Rewrites static HTML string to turn embeded href and action URLs into AW actions, which, by default, are turned into AWRedirects, or, with the action binding, can execute arbitrary AW code.

When used with content vended by the displaying AW app, and with direct action URLs pointing back at that app, the default redirect will be turned into a "local direct action" invocation, (thereby avoiding the actual redirect and providing / x-page refresh and remote URL annotation)

Bindings
value *

HTML string to be rewritten

String
(get)
action

Invoked after pushing new url to actionUrl to ask app for new page. If null is returned, then an AWRedirect to the actionUrl is used.

AWResponseGenerating
(get)
actionUrl

Push of the url that was just clicked.

String
(set)
actionTarget

href window target (if specified will override any originally on link)

String
(get)
resourceUrl

Push of the url that was/will be just fetched.

String
(set)
replacementUrl

Url to use in place of the pushed resource URL (if null, will fire action)

String
(get)
resourceResponse

Fired to dynamically provide resource data back

AWResponseGenerating
(get)

ariba.ui.widgets
Class HTMLActionFilter

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

public final class HTMLActionFilter
extends AWComponent


Nested Class Summary
static interface HTMLActionFilter.UrlFilter
           
 
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
HTMLActionFilter()
           
 
Method Summary
 AWResponseGenerating currentClicked()
           
 java.lang.String currentPrefix()
           
 java.lang.String currentTarget()
           
 boolean matchIsHref()
           
 java.lang.Object nextAction()
           
 java.lang.String remainderString()
           
 AWResponseGenerating resourceRequest()
           
 java.lang.String staticUrlForActionResults()
           
 boolean useStaticUrl()
           
 
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

_staticUrl

public java.lang.String _staticUrl
Constructor Detail

HTMLActionFilter

public HTMLActionFilter()
Method Detail

nextAction

public java.lang.Object nextAction()

currentPrefix

public java.lang.String currentPrefix()

matchIsHref

public boolean matchIsHref()

currentTarget

public java.lang.String currentTarget()

remainderString

public java.lang.String remainderString()

useStaticUrl

public boolean useStaticUrl()

currentClicked

public AWResponseGenerating currentClicked()

staticUrlForActionResults

public java.lang.String staticUrlForActionResults()

resourceRequest

public AWResponseGenerating resourceRequest()


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