public abstract class

DerivedElementTransform

extends ExpressionGenericTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractAppTransform
			↳	com.microstrategy.web.app.transforms.ExpressionGenericTransform
				↳	com.microstrategy.web.app.transforms.DerivedElementTransform

Known Direct Subclasses

DerivedElementCalculationTransform, DerivedElementFilterTransform, DerivedElementListTransform

Class Overview

The DerivedElementTransform is the transform that is used to render the view and base filters in the MicroStrategy Web GUI. It can transform a FilterElementBean object. Note that this transform extends the ExpressionGenericTransform, which transforms on a ExpressionBean. This is because this transform reuses a vast amount of the rendering methods from that transform, and only overrides filter editor-specific functionality.

Summary

[Expand]

Inherited Constants

From class com.microstrategy.web.app.transforms.ExpressionGenericTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

Fields
protected DerivedElementBean	_myBean

[Expand]

Inherited Fields

From class com.microstrategy.web.app.transforms.ExpressionGenericTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

protected final String	CLASS_INPUT	This field is deprecated. This property is not used anymore by the transform.
protected final String	CLASS_MESSAGE	This field is deprecated. This property is not used anymore by the transform.
protected WebComponent	_bean	Instance of `WebComponent` being transformed.
protected ComponentBlock	_componentBlock
protected String	_cssPrefix	Property corresponding to the value of the `cssPrefix` formal parameter
protected String	_imgBlank	Field that containts the URL location of a blank image (used as the source of most <IMG> tags as the real URL is specified through css).
protected String	_imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected MarkupOutput	_selfOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
protected MarkupOutput	_subOutput	This field is deprecated. this field is no longer used since partial update blocks are now generated via `ComponentBlock`
public FormalParameter	appliesTo	This parameter informs the javascript the id of the bone the actions of this component applies to.
public FormalParameter	contextMenus	This formal parameter is used by the Transform to identify the context-menus definition.
public FormalParameter	cssFile	CSS file that includes the style definition.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	debugErrorFlags	Indicates which extra debug information to include in case of an error.
public FormalParameter	debugFlags	Indicates which debug information to include.
public FormalParameter	dragMode	Indicates the drag mode that the component to render will have.
public FormalParameter	extraInput	Indicates any extra inputs to be included in the forms generated by the transform.
public FormalParameter	extraUrl	Indicates any extra parameters to be included in the links generated by the transform.
public FormalParameter	globalCssErrorMessage	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	globalCssErrorTitle	This field is deprecated. The css class to use cannot be controlled through a formal parameter anymore.
public FormalParameter	height	Indicates the default height of the component.
public FormalParameter	iframeEnabled	Indicates whether the transform supports iframe manipulations.
public FormalParameter	imgWait	This field is deprecated. This value is not used anymore by the Transform as the wait image is included using css.
protected int	indent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
public FormalParameter	initialIndent	This field is deprecated. Indentation is not appended by Transforms anymore. Although it provided a somewhat better looking HTML source, it also affected performance by increasing the HTML size.
protected boolean	isDHTML	This field is deprecated. Use `isDhtml()`.
public FormalParameter	orientation	Indicates the orientation the dialog to render will have.
public FormalParameter	orientationsAllowed	Indicates the orientation modes allowed for the dialog to render.
public FormalParameter	partialIframeUpdate	This formal parameter specifies whether we should replace the whole contentst of the div shell (outerHTML) or the just the inner contents (innerHTML) of that shell div for the transform when the iframe update is going on.
public FormalParameter	processingButtonsFlags	Indicates which buttons to include on the wait page.
public FormalParameter	processingInfoFlags	Indicates which information to include on the wait page.
public FormalParameter	resizeLevel	Indicates whether the component can be resized vertically/horizontally or both or none.
public FormalParameter	scriptClass	Holds the name of the javaScript class (if any) to be associated with the component.
protected static final ScriptVariableJSONEncoder	scriptEndTagEncoder	reference to encoder that deals with tag encoding
public FormalParameter	type	This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is.
public FormalParameter	useDHTML	Indicates whether to use DHTML on the output.
public FormalParameter	width	Indicates the default width of the component.

Public Constructors
	DerivedElementTransform()

Public Methods
boolean	getAutoApply() Returns whether the auto-apply functionality is enabled.
String	getDescription() Returns a textual description of the transform.
Class	getSupportedBeanType() Returns the supported bean type for this transform.
boolean	hasCurrentElement()
void	initializeTransform(Transformable data) Overrides the initializeTransform method with type-specific initialization data.
boolean	isEditable() This method is to return whether the expression should be considered to be editable or not.
boolean	isUpdateManagerEnabled() This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager.
void	renderElementName(MarkupOutput out)
abstract void	renderPreview(MarkupOutput out)

Protected Methods
void	checkDerivedElementType(WebDerivedElement de, int type)
String	getName(Object ob)
abstract void	renderDerivedElement(MarkupOutput out, WebDerivedElement de)
void	renderExpression(MarkupOutput out)
boolean	shallRenderAcceptCancell()

[Expand]

Inherited Methods

From class com.microstrategy.web.app.transforms.ExpressionGenericTransform

From class com.microstrategy.web.app.transforms.AbstractAppTransform

From class com.microstrategy.web.transform.AbstractLayoutTransform

From class com.microstrategy.web.transform.AbstractTransform

void	addFormalParam(FormalParameterImpl formal) This method is used to add a `FormalParameterImpl` object to the transform.
boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
static List<Integer>	getEvents(RequestKeys rkeys) Determines event(s) triggered from the request keys.
FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
String	getID() Returns the unique name of the component to be used as the ID for its shell
MarkupOutput	getPreview() Produces a preview output for this transform.
boolean	isPreviewAvailable() Returns true if this transform supports preview functionality, false otherwise.
boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
FormalParameterImpl	removeFormalParam(String name) Removes the formal parameter with the given name from the formal parameters collection.
void	setAnnotation(FormalParameter fp, FormalParameterAnnotation fpa) Used for internal housekeeping.
void	setDeprecated(FormalParameter fp, String desc) Used for internal housekeeping.
boolean	supports(Class type) Returns true if the transform supports objects of specified type.
boolean	supports(Transformable data) Returns true if the transform supports the specified data object.

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

abstract boolean	canTransform(Transformable data) Checks that the transform supports specified data object and that object is in the state supported by this transform.
abstract String	getDescription() Returns a textual description of the transform.
abstract FormalParameters	getFormalParams() Returns the collection of formal parameters associated with this transform.
abstract String	getID() Returns the unique name of the component to be used as the ID for its shell
abstract MarkupOutput	getPreview() This method is deprecated. This feature is not used
abstract Class	getSupportedBeanType() Returns a root class/interface supported by this transform.
abstract boolean	isPreviewAvailable() This method is deprecated. This feature is not used
abstract boolean	isResolved() Returns whether each required formal parameter has a value associated with it.
abstract boolean	supports(Class beanClass) Returns true if the transform supports objects of specified type.
abstract boolean	supports(Transformable data) Returns true if the transform supports the specified data object.
abstract void	transform(Transformable data, MarkupOutput transOut) Transforms the data object and appends result to the transOut.

Fields

protected DerivedElementBean _myBean

Public Constructors

public DerivedElementTransform ()

Public Methods

public boolean getAutoApply ()

Returns whether the auto-apply functionality is enabled. If this is true, the transform will render the GUI such that it expects that every operation will apply changes to the original expression automatically.

Returns

Whether auto-apply is enabled.

public String getDescription ()

Returns a textual description of the transform.

Returns

The textual description of the transform.

public Class getSupportedBeanType ()

Returns the supported bean type for this transform.

Returns

A Class object representing the bean type this transform supports.

public boolean hasCurrentElement ()

public void initializeTransform (Transformable data)

Overrides the initializeTransform method with type-specific initialization data. This MUST be overridden by any classes which extend this transform if they do not transform on a FilterElement object, because this initializeTransform method assumes that the Transformable passed to it is of type FilterElement.

Parameters

data	The object that is being transformed.

public boolean isEditable ()

This method is to return whether the expression should be considered to be editable or not. If this is true, then the transform may render the expression with editing capabilities. If this is false, then the transform should render the expression in a view-only mode.

Returns

True if the expression should be editable, false otherwise.

public boolean isUpdateManagerEnabled ()

This method can be overridden by child classes to signal whether or not to send all multiple event requests through the update manager. By default, this is false, meaning that the update manager should not be used.

Returns

True if the update manager is enabled, false otherwise.

public void renderElementName (MarkupOutput out)

public abstract void renderPreview (MarkupOutput out)

Protected Methods

protected void checkDerivedElementType (WebDerivedElement de, int type)

Throws

UnsupportedOperationException

protected String getName (Object ob)

protected abstract void renderDerivedElement (MarkupOutput out, WebDerivedElement de)

Throws

UnmodifiableException

Interfaces

Classes

DerivedElementTransform

Class Overview

Summary

Fields

protected DerivedElementBean _myBean

Public Constructors

public DerivedElementTransform ()

Public Methods

public boolean getAutoApply ()

Returns

public String getDescription ()

Returns

public Class getSupportedBeanType ()

Returns

public boolean hasCurrentElement ()

public void initializeTransform (Transformable data)

Parameters

public boolean isEditable ()

Returns

public boolean isUpdateManagerEnabled ()

Returns

public void renderElementName (MarkupOutput out)

public abstract void renderPreview (MarkupOutput out)

Protected Methods

protected void checkDerivedElementType (WebDerivedElement de, int type)

Throws

protected String getName (Object ob)

protected abstract void renderDerivedElement (MarkupOutput out, WebDerivedElement de)

Throws

protected void renderExpression (MarkupOutput out)

protected boolean shallRenderAcceptCancell ()