An AWDragContainer can act as an area of draggable content (Drag Container) and as a draggable control (Drag Control). The Drag Control defines a 'draggable' region that can be selected and dragged by the user. The Drag Container defines the region of content that is moved during the drag. Typically, an AWDragContainer acts as both both a Drag Control and a Drag Container. In other words, the draggable region is the same as the region that will be affected by the drag gesture. In some cases, it is desireable to have a Drag Control that is a subset of the Drag Container. For example, dragging a portlet in the dashboard can be initiated by dragging the menu bar of the portlet (Drag Control) while the drag gesture will affect the entire portlet (Drag Container).

An AWDragContainer is considered to be only a Drag Container if it does not have a drag action defined.

An AWDragContainer acts as a Drag Control if the showParent binding is set to $true. In this case, the AWDragContainer will use its parent AWDragContainer (next component higher in the hierarchy with the the same drag type) as its Drag Container (ie, what is move during the drag gesture).


The tag used as the container for the AWDragContainer. This affects the layout of the draggable content in the page. The allowed values are span or div.


CSS class of the container.


Behavior (JavaScript) to use for element. Default is DrG (and any override should extend this).


Method to be invoked when an AWDragContainer is dragged and dropped on a valid AWDropContainer. The dragAction is a pseudo-action, which should be used to setup any state required by the drop action.

For example when a drag container A is dropped on a drop container B, the dragAction for A is invoked. At this point, the dragAction for A should store some state which will be accessible to the dropAction of B (for example, the requestContext.dict() or in some cross component data structure -- parent component, global data, etc.)

* NOTE: This action is guaranteed to be invoked before the drop action is invoked on a AWDropContainer. This pseudo-action is invoked prior to the real action (drop action) so it should not change any object state which will affect the invokeActionForRequest() phase.

If no dragAction is bound, then this AWDragContainer is assumed to only be a Drag Container and is used to define the content to be moved when a drag gesture is initiated. In this case, this AWDragContainer must contain another AWDragContainer which does define a dragAction in order to be dragged.

type *

Type of object in the drag container. This value is used to determine which drop containers are valid drop locations for when a drag gesture is initiated on this container.


Indicates that the AWDragContainer is a Drag Control. When a drag gesture is initiated, the next AWDragContainer with the same drag type in the component hierarchy is used as the Drag Container for the gesture.


Conditionalizes the AWDragContainer. If this binding is set to $false, then the AWDragContainer does nothing more than render its component content.


Class AWDragContainer

  extended by ariba.ui.aribaweb.util.AWBaseObject
      extended by ariba.ui.aribaweb.core.AWComponent
          extended by ariba.ui.aribaweb.core.AWDragContainer
All Implemented Interfaces:
AWCycleable, AWCycleableReference, AWResponseGenerating, AWResponseGenerating.ResponseSubstitution, AWObject

public final class AWDragContainer
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
Constructor Summary
Method Summary
 java.lang.String cssClass()
 AWResponseGenerating fireAction()
 boolean isContainer()
static AWResponseGenerating processAction(AWComponent component, AWEncodedString elementId)
 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, 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, 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


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


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


public AWEncodedString _elementId
Constructor Detail


public AWDragContainer()
Method Detail


public java.lang.String[] supportedBindingNames()
supportedBindingNames in class AWComponent


public void sleep()


public static AWResponseGenerating processAction(AWComponent component,
                                                 AWEncodedString elementId)


public AWResponseGenerating fireAction()


public boolean isContainer()


public java.lang.String cssClass()

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