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
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
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

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.