public abstract class

AbstractUserEntitiesTreeCartTransform

extends AbstractAppTransform
implements LayoutTransform
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
Known Direct Subclasses

Summary

Constants
int INCREMENTAL_FETCH_NEXT
int INCREMENTAL_FETCH_PREVIOUS
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected FormalParameter groupImage
protected FormalParameter nextImage
protected FormalParameter previousImage
protected FormalParameter userImage
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractUserEntitiesTreeCartTransform()
Public Methods
String getID()
Returns the unique name of the component to be used as the ID for its shell.
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.

void renderJavaScriptLinks(MarkupOutput out)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
abstract void addDynamicScript(MarkupOutput out)
CartElements getAvailableItems()
String getBeanPath()
Returns the path within the application of the WebBean being transformed.
abstract String getCartElementValue(WebObjectInfo object)
abstract WebEvent getExpandGroupEvent(WebObjectInfo group)
abstract WebEvent getExpandGroupEvent(String groupId)
CartElementTree getIncrementalFetchElement(int type)
WebEvent getIncrementalFetchEvent(int type)
abstract String getJavaScriptSelectorClearEvent()
abstract String getJavaScriptSelectorEvent()
TreeCart getNewTreeCart()
abstract String getSearchArgument()
abstract WebEvent getSearchEvent()
abstract String getSearchValue()
CartElements getSelectedItems()
abstract UserEntitiesBean getSelectorAvailableItems()
abstract UserEntitiesBean getSelectorSelectedItems()
TreeCart getTreeCart()
String getTreeCartBoneID()
abstract UserEntitiesBrowserBean getUserEntitiesBrowserBean()
boolean isIncrementalFetchApplicable(int type)
boolean isPartialRequest()
abstract boolean isSearchRequest()
boolean isTreeRequest()
abstract boolean isValidItemAvailable(UserEntityBean element)
TreeView newTreeView()
void renderCompleteRequest(MarkupOutput out)
void renderPartialRequest(MarkupOutput out)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.app.transforms.AppTransform
From interface com.microstrategy.web.transform.LayoutTransform
From interface com.microstrategy.web.transform.Transform

Constants

protected static final int INCREMENTAL_FETCH_NEXT

Constant Value: -1 (0xffffffff)

protected static final int INCREMENTAL_FETCH_PREVIOUS

Constant Value: -2 (0xfffffffe)

Fields

protected FormalParameter groupImage

protected FormalParameter nextImage

protected FormalParameter previousImage

protected FormalParameter userImage

Public Constructors

public AbstractUserEntitiesTreeCartTransform ()

Public Methods

public String getID ()

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).

Returns
  • the component's unique id

public void initializeImages ()

Initialize the images to be used by this transform.

public void initializeTransform (Transformable data)

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.

Parameters
data the bean to transform.

public void renderJavaScriptLinks (MarkupOutput out)

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is 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.

Parameters
out output by this transform

Protected Methods

protected abstract void addDynamicScript (MarkupOutput out)

protected CartElements getAvailableItems ()

protected String getBeanPath ()

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.

Returns
  • String

protected abstract String getCartElementValue (WebObjectInfo object)

protected abstract WebEvent getExpandGroupEvent (WebObjectInfo group)

protected abstract WebEvent getExpandGroupEvent (String groupId)

protected CartElementTree getIncrementalFetchElement (int type)

protected WebEvent getIncrementalFetchEvent (int type)

protected abstract String getJavaScriptSelectorClearEvent ()

protected abstract String getJavaScriptSelectorEvent ()

protected TreeCart getNewTreeCart ()

protected abstract String getSearchArgument ()

protected abstract WebEvent getSearchEvent ()

protected abstract String getSearchValue ()

protected CartElements getSelectedItems ()

protected abstract UserEntitiesBean getSelectorAvailableItems ()

protected abstract UserEntitiesBean getSelectorSelectedItems ()

protected TreeCart getTreeCart ()

protected String getTreeCartBoneID ()

protected abstract UserEntitiesBrowserBean getUserEntitiesBrowserBean ()

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)

protected void renderPartialRequest (MarkupOutput out)