public class

PromptXSLTransform

extends AbstractPromptObjectTransform

java.lang.Object
↳	com.microstrategy.web.transform.AbstractTransform
	↳	com.microstrategy.web.transform.AbstractLayoutTransform
		↳	com.microstrategy.web.app.transforms.AbstractPromptObjectTransform
			↳	com.microstrategy.web.app.transforms.PromptXSLTransform

Class Overview

The PromptXSLTransform delegates generation of the HTML of a prompt to an external xsl transformation. The name of the xsl file to use is specified through the xslFileName Formal Paramter.

Summary

[Expand]

Inherited Constants

From interface com.microstrategy.web.beans.EnumPromptsBeanEvents

Fields
public FormalParameter	xslFileName	Specifies the name of the xsl file to use.

[Expand]

Inherited Fields

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

protected int	_blockCount	Denotes generic block count.
protected GGCalendar	_calendar	Represents calendar object.
protected String	_cssPrefix	Property for storing the value of the `cssPrefix` formal parameter, initialized with the `initializeCss` method.
protected int	_dataTypeForCalendar	Specifies data type for calendar.
protected String	_globalCss	Specifies CSS class of the main HTML container tag of the prompt information.
protected String	_imagesFolder	Indicates images folder path.
public FormalParameter	cssPrefix	Prefix to append to all css class names.
public FormalParameter	imgBackToTop	This field is deprecated. This formal parameter is no longer used. There are no references to this formal parameter in the code
public FormalParameter	imgCalendar	Specifies image to use when Calendar object is enabled and visible.
public FormalParameter	imgError	Specifies the image to use to highlight an error in a prompt.
protected boolean	isDhtmlMode	Indicates whether or not DHTML mode is enabled.
public FormalParameter	levelFlag	Specifies what fields in prompt question are displayed.
public FormalParameter	showRequired	Specifies whether or not to display 'Required' message at the end of prompt title.

Public Constructors
	PromptXSLTransform() Default no-args constructor.

Public Methods
String	getDescription() Indicates prompts transform description.
boolean	isAnswerComplex() Indicates whether or not answer is considered as complex.
void	renderPromptContent(MarkupOutput out) Renders prompt's content.

Protected Methods
String	getDefaultXslFileName(WebPrompt prompt) Returns the DefaultStyle names to use to render a prompt based on its type.
Document	getPromptXmlDocument() Returns XML Document denoting prompt in given Document.
String	getStyleXsl(WebPrompt prompt) This method is deprecated. use `getXslFileName()` instead
Document	getXslDocument() Returns instance of Document from ResourceCacheManager object.
String	getXslFileName() Indicates name of the XSL file to be read.

[Expand]

Inherited Methods

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

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

public FormalParameter xslFileName

Specifies the name of the xsl file to use. If the value is empty (default) it will use the name of the file as defined in the prompt's PSXSL extended property or will just default to some xsl based on the prompts type.

Public Constructors

public PromptXSLTransform ()

Default no-args constructor.
Initialize all Formal Parameters.

Public Methods

public String getDescription ()

Indicates prompts transform description.

Returns

String full description.

public boolean isAnswerComplex ()

Indicates whether or not answer is considered as complex.

Returns

boolean true if complex

public void renderPromptContent (MarkupOutput out)

Renders prompt's content.

Parameters

out	`MarkupOutput` where to write the output of the method.

Protected Methods

protected String getDefaultXslFileName (WebPrompt prompt)

Returns the DefaultStyle names to use to render a prompt based on its type.
This correspond to the same default values used in Microstrategy 7i.

Parameters

prompt	WebPrompt instance whose type will determine XSL style name.

Returns

String text indicating XSL file name.

protected Document getPromptXmlDocument ()

Returns XML Document denoting prompt in given Document.

Returns

Document instance if XML is parsed properly.

Throws

XMLSupportException	if error is thrown when getting XML.

protected String getStyleXsl (WebPrompt prompt)

This method is deprecated.
use getXslFileName() instead

Returns the name of the xsl file to use for this prompt.

Parameters

prompt	WebPrompt the prompt

Returns

String the name of the xsl file to use.

protected Document getXslDocument ()

Returns instance of Document from ResourceCacheManager object.
It used current XSL file name in order to get XSL Document object.

Returns

Document instance

protected String getXslFileName ()

Indicates name of the XSL file to be read.

Returns

String file name.

Interfaces

Classes

PromptXSLTransform

Class Overview

Summary

Fields

public FormalParameter xslFileName

Public Constructors

public PromptXSLTransform ()

Public Methods

public String getDescription ()

Returns

public boolean isAnswerComplex ()

Returns

public void renderPromptContent (MarkupOutput out)

Parameters

Protected Methods

protected String getDefaultXslFileName (WebPrompt prompt)

Parameters

Returns

protected Document getPromptXmlDocument ()

Returns

Throws

protected String getStyleXsl (WebPrompt prompt)

Parameters

Returns

protected Document getXslDocument ()

Returns

protected String getXslFileName ()

Returns