<a:RefreshRegion>

Indicates a region that should be considered for incremental DOM update (AJAX) without requiring update of its surrounding content.

RefreshRegions, by default, wrap their content in a div (with an id). If, on subsequent renderings, the contents of a refresh regions has changed (and any parent regions enclosing it have not) then only the changes for this regions need be sent to the client.

Bindings

tagName	By default we use an div with an inline display style to as the container for the refresh region. Span has a problem if the content contains block elements on IE, so it's not recommended for use.	String (get)
elementId		String (set)
useId	id to use for refresh region (instead of a dynamically constructed elementId. Used by BasicPageWrapper to force stable cross-page RefreshRegions ids (to enable incremental refresh even when page structure may have caused elementId misalignment).	String (get)
style	Inline styles for the refresh region.	String (get)
class	The default class (rr) keeps the default container type (div) from disturbing the content surrounding the AWRefreshRegion.	String (get)
isScope	Indicates that this AWRefreshRegion wraps other AWRefreshRegion(s). Causes this AWRefreshRegion to render itself if any of its child AWRefreshRegion's are rendered. Example: <a:RefreshRegion tagName="table" isScope="$true"> <tr><td> static content </td></tr> <a:RefreshRegion tagName="tr"> <td> some changeable content </td> </a:RefreshRegion> </a:RefreshRegion> If the table AWRefreshRegion does not have isScope="$true", then if the tr AWRefreshRegion changed, the following HTML would be rendered: <tr><td> some changeable content</td></tr> Alternatively, if the AWRefreshRegion does have isScope="$true", then the HTML output would be: <table> <tr><td> static content </td></tr> <tr><td> some changeable content</td></tr> </table>	String (get)
alwaysRender	Causes the contents of this AWRefreshRegion to always be rendered regardless of whether or not the contents have changed since the last rendering.	boolean (get)
dropAction	Action to invoke.	AWResponseGenerating (get)
dragAction	Action to invoke.	void (get)
disabled	If set to true, causes the AWRefreshRegion to act like an AWGenericContainer.	boolean (get)
omitTags	Disable refresh region (don't render surrounding tags, but render content)	boolean (get)
ignore	Indicates that this AWRefreshRegion should be ignored during incremental updates. (This binding is passed through to the HTML and is used to indicate to the client update code that this AWRefreshRegion should be ignored during incremental updates.)	boolean (get)
forceRefreshOnChange	If true, we will force an FPR if this region changes across pages (useful, for instance, on global-scoped JavaScript / VBScript (see AWClientsideScript...)	boolean (get)

ariba.ui.aribaweb.core
Class AWRefreshRegion

java.lang.Object
  ariba.ui.aribaweb.util.AWBaseObject
      ariba.ui.aribaweb.core.AWComponent
          ariba.ui.aribaweb.core.AWRefreshRegion

All Implemented Interfaces:

AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

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

AWRefreshRegion()

Method Summary

java.lang.Object	getClassName()
AWResponseGenerating	invokeAction(AWRequestContext requestContext, AWComponent component) The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.
boolean	isClassicRefreshRegion()
boolean	isSender()
void	popBuffer()
void	pushBuffer()
void	renderResponse(AWRequestContext requestContext, AWComponent component) The receiver should render its content to the AWRequestContext.response()
void	sleep()
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, 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, 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

NullActionBinding

public static final AWBinding NullActionBinding

_isDisabled

public boolean _isDisabled

_dragEnabled

public boolean _dragEnabled

_elementId

public AWEncodedString _elementId

_tagName

public java.lang.String _tagName

_classBinding

public AWBinding _classBinding

_hasValueBinding

public boolean _hasValueBinding

_hasRequiresRefreshBinding

public boolean _hasRequiresRefreshBinding

Constructor Detail

AWRefreshRegion

public AWRefreshRegion()

Method Detail

supportedBindingNames

public java.lang.String[] supportedBindingNames()

Overrides:

supportedBindingNames in class AWComponent

sleep

public void sleep()

pushBuffer

public void pushBuffer()

popBuffer

public void popBuffer()

isSender

public boolean isSender()

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

invokeAction

public AWResponseGenerating invokeAction(AWRequestContext requestContext,
                                         AWComponent component)

Description copied from interface: AWCycleable

The receiver should determine if it is the intended recipient of the current action (by checking the AWRequestContext.request() AWRequest.senderId()) and, if so, handle the action and return the result.

Specified by:

invokeAction in interface AWCycleable

Overrides:

invokeAction in class AWComponent

Parameters:

requestContext - the context for the current request.

component - the current parent component

Returns:

the response for the action

getClassName

public java.lang.Object getClassName()

isClassicRefreshRegion

public boolean isClassicRefreshRegion()