public abstract class

AbstractAppWidgetTransform

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.AbstractAppWidgetTransform
Known Direct Subclasses
Known Indirect Subclasses

Summary

[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractAppWidgetTransform()
Public Methods
List<WebAttributeForm> getAttForms(WebAttribute att, int displayedForm)
Block getChildWidget(WebBean bean, String styleName)
Block getChildWidget(String styleName)
String getCssName(WebObjectInfo object)
Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.
int getIserverNodeFunction(WebOperatorNode node)
Returns the funtion of this node defined by IServer.
String getObjectInfoCssName(WebObjectInfo object)
String getPreferenceValueReplaceNull(String prefName, String nullReplace)
Object getSelf(Object obj)
Returns the input argument as return value.
boolean inTreeStructure()
boolean includeAncestorInfo()
boolean includeFolderInfo()
boolean includeOwnerInfo()
boolean includeTimeInfo()
boolean isNull(Object obj)
Returns whether the input argument is null.
boolean isShowObjectTags()
void renderShell(MarkupOutput out)
Overrides the default "shell" created when the transform is invoked.
void renderTest(String msg)
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
List<FlattenedTreeNode> buildFlattenedExpression(WebExpression exp)
get the answer expression tree and flatten it into a list
void insertChildren(MutableTreeNode treeNode)
[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

Public Constructors

public AbstractAppWidgetTransform ()

Public Methods

public List<WebAttributeForm> getAttForms (WebAttribute att, int displayedForm)

public Block getChildWidget (WebBean bean, String styleName)

public Block getChildWidget (String styleName)

public String getCssName (WebObjectInfo object)

Utility method that helps giving the CSS class to use based on the the object type of the WebObjectInfo instance.

Parameters
object The WebObjectInfo for which it's image name is required.
Returns
  • a String with the name of the CSS class that should be associated with the WebObjectInfo information to display. If the type specified does not match the predefined list of styles, then it returns an empty string.

public int getIserverNodeFunction (WebOperatorNode node)

Returns the funtion of this node defined by IServer. The function gets from WebOperatorNode will return EnumWebMRPFunction when its function type is WebFunctionTypePercentQual or WebFunctionTypeRankQual. This method will recover the original function from IServer, which only can be value from enumeration EnumDSSXMLFunction.

public String getObjectInfoCssName (WebObjectInfo object)

public String getPreferenceValueReplaceNull (String prefName, String nullReplace)

public Object getSelf (Object obj)

Returns the input argument as return value. This method is used in layout when one base value needs to assign to another base value. For example, we have base "obj", then when the type of "obj" is a certain value, we would like base "obj2" equals to "obj". Then in layout we can have . After this, obj2 points to the same object as "obj" points to.

Parameters
obj object to return
Returns
  • Returns the input argument.

public boolean inTreeStructure ()

public boolean includeAncestorInfo ()

public boolean includeFolderInfo ()

public boolean includeOwnerInfo ()

public boolean includeTimeInfo ()

public boolean isNull (Object obj)

Returns whether the input argument is null.

Parameters
obj The object to check again null
Returns
  • true if the input is null, otherwise false is returned.

public boolean isShowObjectTags ()

public void renderShell (MarkupOutput out)

Overrides the default "shell" created when the transform is invoked. Ideally, it would be better if we could initialize this transform with a field that indicates whether the HTML shell is created or not. In this way, subclasses can merely override this property (perhaps in their constructor) and affect how the renderShell method is invoked. Alternatively, the renderShell can be structured as a Template method to allow subclasses to easily override those methods that they do not want called.

Parameters
out The MarkupOutput representing the generated content.

public void renderTest (String msg)

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 List<FlattenedTreeNode> buildFlattenedExpression (WebExpression exp)

get the answer expression tree and flatten it into a list

protected void insertChildren (MutableTreeNode treeNode)