java.lang.Object
- com.microstrategy.web.transform.AbstractTransform
- - com.microstrategy.web.transform.AbstractLayoutTransform
  - - com.microstrategy.web.app.transforms.AbstractAppTransform
    - - com.microstrategy.web.app.transforms.AbstractUserEntitiesTreeCartTransform

All Implemented Interfaces:

AppTransform, LayoutTransform, Transform

Direct Known Subclasses:

SecurityRoleUserEntitiesSelectorTransform, UserEntitiesSelectorTreeCartTransform
```
public abstract class AbstractUserEntitiesTreeCartTransform
extends AbstractAppTransform
implements LayoutTransform
```
Since:

MicroStrategy Web 9.0.0

Nested Class Summary
- Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
  AbstractAppTransform.Context

Field Summary

Fields
Modifier and Type	Field	Description
`protected FormalParameter`	`groupImage`
`protected static int`	`INCREMENTAL_FETCH_NEXT`
`protected static int`	`INCREMENTAL_FETCH_PREVIOUS`
`protected FormalParameter`	`nextImage`
`protected FormalParameter`	`previousImage`
`protected FormalParameter`	`userImage`

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
_bean, _componentBlock, _cssPrefix, _imgBlank, _imgWait, _selfOutput, _subOutput, appliesTo, CLASS_INPUT, CLASS_MESSAGE, contextMenus, cssFile, cssPrefix, debugErrorFlags, debugFlags, dragMode, extraInput, extraUrl, FP_APPLIES_TO, FP_CONTEXT_MENUS, FP_CSS_ERROR_MESSAGE, FP_CSS_ERROR_TITLE, FP_CSS_FILE, FP_CSS_PREFIX, FP_DEBUG_ERROR_FLAGS, FP_DEBUG_FLAGS, FP_DRAG_MODE, FP_EXTRA_INPUT, FP_EXTRA_URL, FP_HEIGHT, FP_IFRAME_ENABLED, FP_IMG_WAIT, FP_INITIAL_INDENT, FP_ORIENTATION, FP_ORIENTATIONS_ALLOWED, FP_PARTIAL_IFRAME_UPDATE, FP_PROCESSING_BUTTONS_FLAGS, FP_PROCESSING_INFO_FLAGS, FP_RESIZE_LEVEL, FP_SCRIPT_CLASS, FP_TYPE, FP_USE_DHTML, FP_WIDTH, globalCssErrorMessage, globalCssErrorTitle, height, iframeEnabled, imgWait, indent, initialIndent, isDHTML, orientation, orientationsAllowed, partialIframeUpdate, PROCESSING_BUTTONS_ALL, PROCESSING_BUTTONS_CANCEL, PROCESSING_BUTTONS_HISTORY_LIST, PROCESSING_BUTTONS_REFRESH, PROCESSING_BUTTONS_VIEW_DETAILS, PROCESSING_INFO_ALL, PROCESSING_INFO_DESCRIPTION, PROCESSING_INFO_LAST_UPDATE, PROCESSING_INFO_NAME, PROCESSING_INFO_NONE, PROCESSING_INFO_STATUS, processingButtonsFlags, processingInfoFlags, RESIZE_ALL, RESIZE_HORIZONTAL, RESIZE_NONE, RESIZE_VERTICAL, resizeLevel, scriptClass, scriptEndTagEncoder, type, useDHTML, width

Constructor Summary

Constructors
Constructor Description

AbstractUserEntitiesTreeCartTransform()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`addDynamicScript(MarkupOutput out)`
`protected CartElements`	`getAvailableItems()`
`protected java.lang.String`	`getBeanPath()`	Returns the path within the application of the WebBean being transformed.
`protected abstract java.lang.String`	`getCartElementValue(WebObjectInfo object)`
`protected abstract WebEvent`	`getExpandGroupEvent(WebObjectInfo group)`
`protected abstract WebEvent`	`getExpandGroupEvent(java.lang.String groupId)`
`java.lang.String`	`getID()`	Returns the unique name of the component to be used as the ID for its shell.
`protected CartElementTree`	`getIncrementalFetchElement(int type)`
`protected WebEvent`	`getIncrementalFetchEvent(int type)`
`protected abstract java.lang.String`	`getJavaScriptSelectorClearEvent()`
`protected abstract java.lang.String`	`getJavaScriptSelectorEvent()`
`protected TreeCart`	`getNewTreeCart()`
`protected abstract java.lang.String`	`getSearchArgument()`
`protected abstract WebEvent`	`getSearchEvent()`
`protected abstract java.lang.String`	`getSearchValue()`
`protected CartElements`	`getSelectedItems()`
`protected abstract UserEntitiesBean`	`getSelectorAvailableItems()`
`protected abstract UserEntitiesBean`	`getSelectorSelectedItems()`
`protected TreeCart`	`getTreeCart()`
`protected java.lang.String`	`getTreeCartBoneID()`
`protected abstract UserEntitiesBrowserBean`	`getUserEntitiesBrowserBean()`
`void`	`initializeImages()`	Initialize the images to be used by this transform.
`void`	`initializeTransform(Transformable data)`	This method initialize the private and protected fields of the transform, such as width and height.
`protected boolean`	`isIncrementalFetchApplicable(int type)`
`protected boolean`	`isPartialRequest()`
`protected abstract boolean`	`isSearchRequest()`
`protected boolean`	`isTreeRequest()`
`protected abstract boolean`	`isValidItemAvailable(UserEntityBean element)`
`protected TreeView`	`newTreeView()`
`protected void`	`renderCompleteRequest(MarkupOutput out)`
`void`	`renderJavaScriptLinks(MarkupOutput out)`
`protected void`	`renderPartialRequest(MarkupOutput out)`
`void`	`transformForRequestSuccessful(MarkupOutput out)`	Generates the output when the bean's status is `EnumRequestStatus.WebBeanRequestSuccessful`.

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform
addContactInfo, addDynamicScriptClass, addDynamicScriptFile, addFormalParameter, checkLevel, checkProcessingButtonsFlag, checkProcessingInfoFlag, checkStatus, displayError, displayError, displayError, emptyCell, excludeStaticTags, generateAnchor, generateAnchorForExport, generateHiddenInputsForEvent, generateIFrameTag, getAppContext, getArgumentName, getAttributesShellDiv, getBoneId, getCancelEvent, getClientSideHelper, getContainerServices, getContext, getContextMenu, getContextMenuManager, getContextMenuManagerName, getContextMenusDefinition, getCssPrefix, getDateFormat, getDebugOut, getDescriptor, getDescriptor, getDescriptor, getDescriptor, getDisplayMode, getDisplayName, getErrorMessage, getErrorMessage, getErrorTitle, getErrorTitle, getEventManager, getFirstDayOfWeek, getFloatValue, getHelpPath, getIntValue, getJSNameSpace, getLayoutContext, getLocale, getLocale, getPreferenceValue, getProjectID, getRefreshEvent, getRequestKeys, getResourcesFolder, getScriptClass, getStringValue, getStyleRequestContext, getStyleShellDiv, getSupportedBeanType, getTagsFactory, getTimeFormat, getUnitsLabel, getWebBeanErrorInfo, hasSubBlock, initHeightAndWidthFromPreferences, initializeCss, initializeWebComponent, is508, isBlockMode, isContextMenusEnabled, isDhtml, isDialog, isDormant, isFeatureAvailable, isIFrameDisplayMode, isIFrameEnabled, isIFrameRequest, isJobExpired, isModal, isOpen, isPortlet, isTrue, localIsIFrameDisplayMode, newContext, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, redirectToDisplayError, renderBean, renderBean, renderBean, renderBean, renderCancelButton, renderContextMenus, renderCssLink, renderDescriptor, renderDescriptor, renderErrorButton, renderHiddenInputFromRequest, renderImage, renderLayout, renderProcessingButton, renderProcessingButton, renderProcessingButton, renderProcessingButtonForGet, renderProcessingButtonForGet, renderProcessingButtons, renderProcessingInfo, renderProcessingInfoData, renderProcessingInfoImage, renderProcessingInfoSubtitle, renderProcessingInfoTitle, renderProcessingObjectName, renderRefreshButton, renderRegisterBone, renderSelf, renderShell, renderSubBlock, renderUserHelpAnchor, setBoneProperties, setDisplayMode, setHasSubBlock, setHeight, setIFrameDisplayMode, setIsDormant, setRenderSubBlock, setShellAttributeOnClosedComponent, setWidth, shouldDisplay, transform, transformForRequestCanceled, transformForRequestInError, transformForRequestNotInited, transformForRequestProcessing, transformForRequestWaitingForUserInput

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform
getLayoutDefinition, setLayoutDefinition, transformUsingLayout

Methods inherited from class com.microstrategy.web.transform.AbstractTransform
addFormalParam, canTransform, getEvents, getFormalParams, getPreview, isPreviewAvailable, isResolved, removeFormalParam, setAnnotation, setDeprecated, supports, supports

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform
getLayoutDefinition, setLayoutDefinition

Methods inherited from interface com.microstrategy.web.transform.Transform
canTransform, getDescription, getFormalParams, getPreview, getSupportedBeanType, isPreviewAvailable, isResolved, supports, supports, transform

- Field Detail
  - userImage
```
protected FormalParameter userImage
```
  - groupImage
```
protected FormalParameter groupImage
```
  - previousImage
```
protected FormalParameter previousImage
```
  - nextImage
```
protected FormalParameter nextImage
```
  - INCREMENTAL_FETCH_PREVIOUS
```
protected static final int INCREMENTAL_FETCH_PREVIOUS
```
    See Also:
    
    Constant Field Values
  - INCREMENTAL_FETCH_NEXT
```
protected static final int INCREMENTAL_FETCH_NEXT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractUserEntitiesTreeCartTransform
```
public AbstractUserEntitiesTreeCartTransform()
```
- Method Detail
  - initializeImages
```
public void initializeImages()
```
    Description copied from class: AbstractAppTransform
    
    Initialize the images to be used by this transform.
    
    Overrides:
    
    initializeImages in class AbstractAppTransform
  - isPartialRequest
```
protected boolean isPartialRequest()
```
  - renderPartialRequest
```
protected void renderPartialRequest(MarkupOutput out)
```
  - renderCompleteRequest
```
protected void renderCompleteRequest(MarkupOutput out)
```
  - transformForRequestSuccessful
```
public void transformForRequestSuccessful(MarkupOutput out)
```
    Description copied from class: AbstractAppTransform
    
    Generates the output when the bean's status is EnumRequestStatus.WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
    This is an abstract method. All classes need to implement it.
    
    Specified by:
    
    transformForRequestSuccessful in class AbstractAppTransform
    
    Parameters:
    
    out - output by this transform
    
    See Also:
    
    AbstractAppTransform.checkStatus(com.microstrategy.web.beans.MarkupOutput)
  - addDynamicScript
```
protected abstract void addDynamicScript(MarkupOutput out)
```
  - getJavaScriptSelectorEvent
```
protected abstract java.lang.String getJavaScriptSelectorEvent()
```
  - getJavaScriptSelectorClearEvent
```
protected abstract java.lang.String getJavaScriptSelectorClearEvent()
```
  - renderJavaScriptLinks
```
public void renderJavaScriptLinks(MarkupOutput out)
```
  - getBeanPath
```
protected java.lang.String getBeanPath()
```
    Description copied from class: AbstractAppTransform
    
    Returns the path within the application of the WebBean being transformed.
    When submitting an WebEvent, this path allows Microstrategy Web to uniquely identify the location of the bean that needs to handle the event.
    This method is used by the renderRegisterBone method to inform the javascript bone the bean to whom it should send its server-side requests.
    
    Overrides:
    
    getBeanPath in class AbstractAppTransform
    
    Returns:
    
    String
    
    See Also:
    
    WebComponent.getPath(), AbstractAppTransform.renderRegisterBone(com.microstrategy.web.beans.MarkupOutput)
  - getTreeCart
```
protected TreeCart getTreeCart()
```
  - initializeTransform
```
public void initializeTransform(Transformable data)
```
    Description copied from class: AbstractAppTransform
    
    This method initialize the private and protected fields of the transform, such as width and height. It also invokes the initializeWebComponent, initializeImages and initializeCss methods.
    This method is automatically called from the transform method. Transforms which would like to invoke other methods in this instance directly (for example, to invoke some render methods), need first to call this method to guarantee that the Transform is ready to generate output.
    
    Specified by:
    
    initializeTransform in interface AppTransform
    
    Overrides:
    
    initializeTransform in class AbstractAppTransform
    
    Parameters:
    
    data - the bean to transform.
  - getNewTreeCart
```
protected TreeCart getNewTreeCart()
```
  - getSearchEvent
```
protected abstract WebEvent getSearchEvent()
```
  - getSearchArgument
```
protected abstract java.lang.String getSearchArgument()
```
  - getSearchValue
```
protected abstract java.lang.String getSearchValue()
```
  - isSearchRequest
```
protected abstract boolean isSearchRequest()
```
  - isTreeRequest
```
protected boolean isTreeRequest()
```
  - getTreeCartBoneID
```
protected java.lang.String getTreeCartBoneID()
```
  - getID
```
public java.lang.String getID()
```
    Description copied from class: AbstractAppTransform
    
    Returns the unique name of the component to be used as the ID for its shell. This id is used for updating the page using the iFrame technology, and as the id for the corresponding bone (if any).
    
    Specified by:
    
    getID in interface Transform
    
    Overrides:
    
    getID in class AbstractAppTransform
    
    Returns:
    
    the component's unique id
  - newTreeView
```
protected TreeView newTreeView()
```
  - getSelectorAvailableItems
```
protected abstract UserEntitiesBean getSelectorAvailableItems()
```
  - isValidItemAvailable
```
protected abstract boolean isValidItemAvailable(UserEntityBean element)
```
  - getAvailableItems
```
protected CartElements getAvailableItems()
```
  - getIncrementalFetchElement
```
protected CartElementTree getIncrementalFetchElement(int type)
```
  - isIncrementalFetchApplicable
```
protected boolean isIncrementalFetchApplicable(int type)
```
  - getIncrementalFetchEvent
```
protected WebEvent getIncrementalFetchEvent(int type)
```
  - getUserEntitiesBrowserBean
```
protected abstract UserEntitiesBrowserBean getUserEntitiesBrowserBean()
```
  - getSelectorSelectedItems
```
protected abstract UserEntitiesBean getSelectorSelectedItems()
```
  - getSelectedItems
```
protected CartElements getSelectedItems()
```
  - getExpandGroupEvent
```
protected abstract WebEvent getExpandGroupEvent(WebObjectInfo group)
```
  - getExpandGroupEvent
```
protected abstract WebEvent getExpandGroupEvent(java.lang.String groupId)
```
  - getCartElementValue
```
protected abstract java.lang.String getCartElementValue(WebObjectInfo object)
```

Class AbstractUserEntitiesTreeCartTransform

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Field Summary

Fields inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Constructor Summary

Method Summary

Methods inherited from class com.microstrategy.web.app.transforms.AbstractAppTransform

Methods inherited from class com.microstrategy.web.transform.AbstractLayoutTransform

Methods inherited from class com.microstrategy.web.transform.AbstractTransform

Methods inherited from class java.lang.Object

Methods inherited from interface com.microstrategy.web.transform.LayoutTransform

Methods inherited from interface com.microstrategy.web.transform.Transform

Field Detail

userImage

groupImage

previousImage

nextImage

INCREMENTAL_FETCH_PREVIOUS

INCREMENTAL_FETCH_NEXT

Constructor Detail

AbstractUserEntitiesTreeCartTransform

Method Detail

initializeImages

isPartialRequest

renderPartialRequest

renderCompleteRequest

transformForRequestSuccessful

addDynamicScript

getJavaScriptSelectorEvent

getJavaScriptSelectorClearEvent

renderJavaScriptLinks

getBeanPath

getTreeCart

initializeTransform

getNewTreeCart

getSearchEvent

getSearchArgument

getSearchValue

isSearchRequest

isTreeRequest

getTreeCartBoneID

getID

newTreeView

getSelectorAvailableItems

isValidItemAvailable

getAvailableItems

getIncrementalFetchElement

isIncrementalFetchApplicable

getIncrementalFetchEvent

getUserEntitiesBrowserBean

getSelectorSelectedItems

getSelectedItems

getExpandGroupEvent

getExpandGroupEvent

getCartElementValue