public interface

AppTransform

implements Transform
com.microstrategy.web.app.transforms.AppTransform
Known Indirect Subclasses

Summary

Public Methods
abstract String getDisplayMode()
get the display mode used when the GuiComponent renders itself
abstract void initializeTransform(Transformable data)

This method initialize the private and protected fields of the transform, such as width and height.

abstract void initializeWebComponent(Transformable data)
Initialize the web component to be used by the transform.
abstract boolean isDormant()
abstract boolean isIFrameDisplayMode()
abstract void setDisplayMode(String newValue)
set the display mode used when the GuiComponent renders itself
abstract void setIFrameDisplayMode(boolean value)
Determines if the display mode should consider iframe request or not.
abstract void setIsDormant(boolean isDormant)
Tells the transform whether the bone is dormant or not, in which case it should not receive event notification.
[Expand]
Inherited Methods
From interface com.microstrategy.web.transform.Transform

Public Methods

public abstract String getDisplayMode ()

get the display mode used when the GuiComponent renders itself

public abstract 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 abstract void initializeWebComponent (Transformable data)

Initialize the web component to be used by the transform.

Parameters
data the bean to transform.

public abstract boolean isDormant ()

public abstract boolean isIFrameDisplayMode ()

public abstract void setDisplayMode (String newValue)

set the display mode used when the GuiComponent renders itself

Parameters
newValue String the display mode: DISPLAY_MODE_HTML - plain HTML DISPLAY_MODE_JSON - the output will be wrapped up in a json structure in form of {id: id of the component, content: html content to be updated} or {id: if of the component, components: sub json blocks}

public abstract void setIFrameDisplayMode (boolean value)

Determines if the display mode should consider iframe request or not. A sample application of this logic will be to determine if the COMMENT HTML tags have to be generated in order for the response to be processed correctly by the iframe in the page.

Parameters
value boolean indicating if the display mode of this transform should be generated for iframe manipulation or not

public abstract void setIsDormant (boolean isDormant)

Tells the transform whether the bone is dormant or not, in which case it should not receive event notification.

Parameters
isDormant boolean