public abstract class

AbstractDocumentTransform

extends AbstractWebBeanTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractAppTransform
			↳	com.microstrategy.web.app.transforms.AbstractWebBeanTransform
				↳	com.microstrategy.web.app.transforms.AbstractDocumentTransform

Known Direct Subclasses

DocumentDetailsTransform, DocumentDetailsXHTMLTransform, DocumentFastExportTransform, DocumentSimpleTransform

Known Indirect Subclasses

DocumentExportTransform

Class Overview

AbstractDocumentTransform is an abstract class which acts as a super class for all document transforms. All functional document transform classes, such as DocumentDetailsTransform, DocumentSimpleTransform, ... extend from it. Copyright: Copyright (c) 2001

Summary

[Expand]

Inherited Constants

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

Fields
protected FormalParameter	imgError	The name of the image used when the bean is in error status.

[Expand]

Inherited Fields

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
	AbstractDocumentTransform() Default no argument constructor.

Public Methods
boolean	canTransform(Transformable data) Returns true if the bean is not waiting for user input.
String	getDocumentStatus(int status) Get the document's status as a string representation.
String	getErrorMessage(int errorCode, String defaultMessage) Returns the error message for the transform, based on the exception.
static String	getErrorMessageFromMSTRDocumentException(Throwable cause, String newline)
String	getErrorTitle(int errorCode) Returns the error title for the transform, overwrites by returning title specific about document execution.
String	getJobExpiredMessage()
String	getReexecuteButtonDescription()
Class	getSupportedBeanType() Returns the supported bean type for the transform.
WebEvent	getWebReexecuteEvent() Returns the reexecute event Always get the event from the servlet.
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.
void	renderErrorButtons(MarkupOutput out, int errorCode, String message) This method is deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
void	renderErrorInfo(MarkupOutput out, int errorCode, String message) This method is deprecated. This method is no longer used by the Transform, all the logic is now in the transformForRequestInError
void	renderImage(MarkupOutput out, String image) Renders a image for this transform.
void	renderProcessingButtons(MarkupOutput out) Renders the buttons while processing.
void	renderProcessingInfo(MarkupOutput out) Renders the information about the bean when it is still processing results.
void	setWebReexecuteEventArguments(WebEvent __result) Sets the reexecute web event's arguments
void	transformForRequestInError(MarkupOutput out) Transform when the status is `In Error`.
void	transformForRequestNotInited(MarkupOutput out) Transform when the status is `Not initialized`.

Protected Methods
WebEvent	getCancelEvent()
WebEvent	getContinueEvent() Returns an event to continue browsing if an error happened.
DocumentBean	getDocumentBean() Returns the documentBean being transformed.
WebEvent	getHistoryListEvent()
WebInboxSource	getInboxSource() Returns the InboxSource of this session.
WebEvent	getRefreshEvent()
void	renderHistoryListButton(MarkupOutput out) Renders the History List button for the wait page.
void	renderProcessingInfoDetails(MarkupOutput out)

[Expand]

Inherited Methods

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

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.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 FormalParameter imgError

The name of the image used when the bean is in error status. Allowed Values:
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.

Public Constructors

public AbstractDocumentTransform ()

Default no argument constructor.

Public Methods

public boolean canTransform (Transformable data)

Returns true if the bean is not waiting for user input.

Parameters

data	The bean to be transformed.

Returns

true if the bean is not waiting for user input.

public String getDocumentStatus (int status)

Get the document's status as a string representation.

Parameters

status	the status as an integer

Returns

the status string

public String getErrorMessage (int errorCode, String defaultMessage)

Returns the error message for the transform, based on the exception.
Overwrites by returning either the original message, or if none was provided, an "Error in document results"

Parameters

errorCode	The ID of the error.
defaultMessage	The error's message.

Returns

The error message.

public static String getErrorMessageFromMSTRDocumentException (Throwable cause, String newline)

public String getErrorTitle (int errorCode)

Returns the error title for the transform, overwrites by returning title specific about document execution.

Parameters

errorCode	The ID of the error.

Returns

The error title.

public String getJobExpiredMessage ()

Returns

the job expired message.

public String getReexecuteButtonDescription ()

Returns

the description of the reexecute button

public Class getSupportedBeanType ()

Returns the supported bean type for the transform.

Returns

The DocumentBean bean for this transform.

public WebEvent getWebReexecuteEvent ()

Returns the reexecute event Always get the event from the servlet.

Returns

the web reexecute event

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.
It also invokes the initializeTransform method of the parent.

Parameters

data	The bean to transform.

public void renderErrorButtons (MarkupOutput out, int errorCode, String message)

This method is deprecated.
This method is no longer used by the Transform, all the logic is now in the transformForRequestInError

Renders the "continue" or "re-execute" button for the user to continue working after an error occurs.

Parameters

out	The transform's output.
errorCode	The If of the error.
message	The error message

public void renderErrorInfo (MarkupOutput out, int errorCode, String message)

This method is deprecated.
This method is no longer used by the Transform, all the logic is now in the transformForRequestInError

Render the message to display to the user in case there is an error.

Parameters

out	The transform's output.
errorCode	The ID of the error.
message	The error message.

public void renderImage (MarkupOutput out, String image)

Renders a image for this transform.
Extends by including images of this transform.

Parameters

out	Output by this transform.
image	The image name

public void renderProcessingButtons (MarkupOutput out)

Renders the buttons while processing.
Overwrites by setting the corresponding buttons for Documents.

Parameters

out	Output by this transform.

public void renderProcessingInfo (MarkupOutput out)

Renders the information about the bean when it is still processing results.
Overwrites this method by showing information about the document.

Parameters

out	Output by this transform.

public void setWebReexecuteEventArguments (WebEvent __result)

Sets the reexecute web event's arguments

Throws

	WebBeanException
WebBeanException

public void transformForRequestInError (MarkupOutput out)

Transform when the status is In Error.

Parameters

out	Output by this transform.

public void transformForRequestNotInited (MarkupOutput out)

Transform when the status is Not initialized.

Parameters

out	Output by this transform.

Protected Methods

protected WebEvent getCancelEvent ()

Returns

WebEvent instance initialized with the information for cancelling a request

protected WebEvent getContinueEvent ()

Returns an event to continue browsing if an error happened.

protected DocumentBean getDocumentBean ()

Returns the documentBean being transformed.

Returns

The DocumentBean being transformed.

protected WebEvent getHistoryListEvent ()

protected WebInboxSource getInboxSource ()

Returns the InboxSource of this session.

Returns

The InboxSource of this session.

protected WebEvent getRefreshEvent ()

Returns

WebEvent instance initialized with the information for refreshing the request

protected void renderHistoryListButton (MarkupOutput out)

Renders the History List button for the wait page.
It calls getHistoryListEvent() to obtain the event used for the button
The button is not rendered if:
- getHistoryListEvent() returns null
- processingButtonsFlags does not have PROCESSING_BUTTONS_HISTORY_LIST

Parameters

out	output for this transform

Interfaces

Classes

AbstractDocumentTransform

Class Overview

Summary

Fields

protected FormalParameter imgError

Public Constructors

public AbstractDocumentTransform ()

Public Methods

public boolean canTransform (Transformable data)

Parameters

Returns

public String getDocumentStatus (int status)

Parameters

Returns

public String getErrorMessage (int errorCode, String defaultMessage)

Parameters

Returns

public static String getErrorMessageFromMSTRDocumentException (Throwable cause, String newline)

public String getErrorTitle (int errorCode)

Parameters

Returns

public String getJobExpiredMessage ()

Returns

public String getReexecuteButtonDescription ()

Returns

public Class getSupportedBeanType ()

Returns

public WebEvent getWebReexecuteEvent ()

Returns

public void initializeImages ()

public void initializeTransform (Transformable data)

Parameters

public void renderErrorButtons (MarkupOutput out, int errorCode, String message)

Parameters

public void renderErrorInfo (MarkupOutput out, int errorCode, String message)

Parameters

public void renderImage (MarkupOutput out, String image)

Parameters

public void renderProcessingButtons (MarkupOutput out)

Parameters

public void renderProcessingInfo (MarkupOutput out)

Parameters

public void setWebReexecuteEventArguments (WebEvent __result)

Throws

public void transformForRequestInError (MarkupOutput out)

Parameters

public void transformForRequestNotInited (MarkupOutput out)

Parameters

Protected Methods

protected WebEvent getCancelEvent ()

Returns

protected WebEvent getContinueEvent ()

protected DocumentBean getDocumentBean ()

Returns

protected WebEvent getHistoryListEvent ()

protected WebInboxSource getInboxSource ()

Returns

protected WebEvent getRefreshEvent ()

Returns

protected void renderHistoryListButton (MarkupOutput out)

Parameters

protected void renderProcessingInfoDetails (MarkupOutput out)