public abstract class

AbstractPromptEditorTransform

extends AbstractAppTransform
implements LayoutTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.transform.AbstractLayoutTransform
       ↳ com.microstrategy.web.app.transforms.AbstractAppTransform
         ↳ com.microstrategy.web.app.transforms.AbstractPromptEditorTransform
Known Direct Subclasses

Summary

Nested Classes
class AbstractPromptEditorTransform.ListItem  
[Expand]
Inherited Constants
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Fields
protected String _imagesFolder Indicates images folder path.
public FormalParameter imgCalendar Specifies image to use when Calendar object is enabled and visible.
protected WebPrompt prompt
protected PromptDefinitionAppBean promptEditor
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractAppTransform
Public Constructors
AbstractPromptEditorTransform()
Public Methods
Map addArrangeSizeAsValue()
Map addAttr(String attName, String attValue)
Adds an attribute, whose attribute name is attName and whose value is attValue.
Map addBackwardDisplay()
Map addCheckedAttr()
Add checked attribute into the attribute map.
Map addDisableObjs(String objs)
Returns the attribute map for default value attribute.
Map addHeightAsValue(String max)
Map addMaxElemPerSubAsValue()
Map addMaxValueAttr()
Add maximum value as a value attribute.
Map addMinValueAttr()
Add minimum value as a value attribute.
Map addNameAsValue()
Map addOptionAttr(AbstractPromptEditorTransform.ListItem value)
Generate attributes for an option node, based on the input ListItem.
Map addPre90StyleAsValue()
Map addTitleAsValue()
Add the title of the prompt as a value attribute into the attribute map.
Map addWidthAsValue(String max)
List getArrangementList()
List getColFillOrderList()
String getDescription()
Returns a textual description of the transform.
List getDisplayStyles()
List getPersonalAnswersAllowedList()
Return a list of allowed personal answers.
List getShowSearchBoxPropValues()
Class getSupportedBeanType()
Returns the supported bean type.
boolean hasMax()
Returns whether the prompt has a maximum value.
boolean hasMin()
Returns whether the prompt has a minimum value.
void initializeImages()
Initializes the images to be used by this transform.
void initializeTransform(Transformable data)

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

boolean isAllowElementBrowse()
boolean isAllowElementImport()
boolean isAllowFullExpChange()
boolean isAllowInterOpChange()
boolean isAllowNavigateAbove()
boolean isAllowOpChange()
boolean isAllowRootOpChange()
boolean isArrangementSizeNonDefault()
boolean isAttributeQualificationPrompt()
boolean isDateRangeAvailable()
boolean isDispOuputLevelSelector()
boolean isDonotShowEmptyFolders()
boolean isElementPrompt()
boolean isExpressionPrompt()
boolean isFixedHeight()
boolean isFixedWidth()
boolean isHierarchyPrompt()
boolean isMaxElemPerSubNonDefault()
boolean isMetricQualificationPrompt()
boolean isOnlyAllowRootOpChange()
boolean isPre90CustomStyle()
boolean isProjectLevelUserAnswerAllowed()
boolean isRequired()
Returns whether the prompt require an answer.
boolean isSearchRequired()
boolean isSearchRequiredAvailable()
boolean isUseFolderStructure()
boolean isUseWebBlocks()
void renderCalendar(MarkupOutput out, String textBoxName, String calendarArg, String maxRestrictionName, String minRestrictionName)
Renders calendar HTML code.
void renderDescription(MarkupOutput out)
Render the description into the output stream.
void renderOptionText(MarkupOutput out, AbstractPromptEditorTransform.ListItem list)
Render the text for an option node based on the input ListItem
void renderText(MarkupOutput out, String text)
Render a text into output stream.
void renderTimePicker(MarkupOutput out, String pickerFieldsName, String onChangeEvent, String hourPickerName, String minPickerName, String secPickerName, String dependField)
void renderUnitsLabel(MarkupOutput mo)
boolean showBackwardCompatibility()
boolean showUserAnswerRestriction()
void transformForRequestSuccessful(MarkupOutput out)
Generates the output when the bean's status is WebBeanRequestSuccessful.
Protected Methods
String buildObjOptionValue(WebObjectInfo obj)
GGCalendar getCalendar()
Returns a localized instance of Calendar component.
abstract List getDisplayStyleList(ArrayList list, String currentStyle)
WebProperty getProperty(String psName, String pName)
String getPropertyValue(String psName, String pName)
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractAppTransform
From class com.microstrategy.web.transform.AbstractLayoutTransform
From class com.microstrategy.web.transform.AbstractTransform
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

Fields

protected String _imagesFolder

Indicates images folder path.

public FormalParameter imgCalendar

Specifies image to use when Calendar object is enabled and visible.
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.

protected WebPrompt prompt

protected PromptDefinitionAppBean promptEditor

Public Constructors

public AbstractPromptEditorTransform ()

Public Methods

public Map addArrangeSizeAsValue ()

public Map addAttr (String attName, String attValue)

Adds an attribute, whose attribute name is attName and whose value is attValue.

public Map addBackwardDisplay ()

public Map addCheckedAttr ()

Add checked attribute into the attribute map.

public Map addDisableObjs (String objs)

Returns the attribute map for default value attribute. If the input data type is the same as the current defined prompt and it has a default value, then this method will return the default value in attribute map. For other cases, except date data type, no attribute will be added. When the input data type is date, and the current prompt is not a date prompt, then the current date will be added as the default value attribute. This means GUI will show current date as default for default value for date type, when the current prompt data type is not Date. This will let calendar picker correctly show the date.

public Map addHeightAsValue (String max)

public Map addMaxElemPerSubAsValue ()

public Map addMaxValueAttr ()

Add maximum value as a value attribute.

public Map addMinValueAttr ()

Add minimum value as a value attribute.

public Map addNameAsValue ()

public Map addOptionAttr (AbstractPromptEditorTransform.ListItem value)

Generate attributes for an option node, based on the input ListItem.

public Map addPre90StyleAsValue ()

public Map addTitleAsValue ()

Add the title of the prompt as a value attribute into the attribute map.

public Map addWidthAsValue (String max)

public List getArrangementList ()

public List getColFillOrderList ()

public String getDescription ()

Returns a textual description of the transform.

Returns
  • The textual description of the transform.

public List getDisplayStyles ()

public List getPersonalAnswersAllowedList ()

Return a list of allowed personal answers.

public List getShowSearchBoxPropValues ()

public Class getSupportedBeanType ()

Returns the supported bean type. This abstract Transform supports all WebComponents so every sub-class should override this method to return the class of the Bean the Transform is expecting, for example:

 public class CustomReportClass extends AbstractAppTransform {

    public Class getSupportedBeanType() {
        //This Transform is expected to work only with a ReportBean,
        //therefore this method needs to return this class:
        return ReportBean.class;
    }

 }
 

Returns
  • a root class/interface supported by this transform.

public boolean hasMax ()

Returns whether the prompt has a maximum value.

public boolean hasMin ()

Returns whether the prompt has a minimum value.

public void initializeImages ()

Initializes the images to be used by this transform.

public 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 boolean isAllowElementBrowse ()

public boolean isAllowElementImport ()

public boolean isAllowFullExpChange ()

public boolean isAllowInterOpChange ()

public boolean isAllowNavigateAbove ()

public boolean isAllowOpChange ()

public boolean isAllowRootOpChange ()

public boolean isArrangementSizeNonDefault ()

public boolean isAttributeQualificationPrompt ()

public boolean isDateRangeAvailable ()

public boolean isDispOuputLevelSelector ()

public boolean isDonotShowEmptyFolders ()

public boolean isElementPrompt ()

public boolean isExpressionPrompt ()

public boolean isFixedHeight ()

public boolean isFixedWidth ()

public boolean isHierarchyPrompt ()

public boolean isMaxElemPerSubNonDefault ()

public boolean isMetricQualificationPrompt ()

public boolean isOnlyAllowRootOpChange ()

public boolean isPre90CustomStyle ()

public boolean isProjectLevelUserAnswerAllowed ()

public boolean isRequired ()

Returns whether the prompt require an answer.

public boolean isSearchRequired ()

public boolean isSearchRequiredAvailable ()

public boolean isUseFolderStructure ()

public boolean isUseWebBlocks ()

public void renderCalendar (MarkupOutput out, String textBoxName, String calendarArg, String maxRestrictionName, String minRestrictionName)

Renders calendar HTML code.
It takes as parameters argument indicating which Textbox to write Dates and unique Id for Calendar denoted by calendarArg.

Parameters
out MarkupOutput where to writhe Calendar HTML code.
textBoxName String Id denoting textbox
calendarArg String Unique Id for Calendar object.

public void renderDescription (MarkupOutput out)

Render the description into the output stream.

public void renderOptionText (MarkupOutput out, AbstractPromptEditorTransform.ListItem list)

Render the text for an option node based on the input ListItem

public void renderText (MarkupOutput out, String text)

Render a text into output stream.

public void renderTimePicker (MarkupOutput out, String pickerFieldsName, String onChangeEvent, String hourPickerName, String minPickerName, String secPickerName, String dependField)

public void renderUnitsLabel (MarkupOutput mo)

public boolean showBackwardCompatibility ()

public boolean showUserAnswerRestriction ()

public void transformForRequestSuccessful (MarkupOutput out)

Generates the output when the bean's status is WebBeanRequestSuccessful. This is the main entry point to generate the output for those Transforms that just want to render the "regular" bean case.
This is an abstract method. All classes need to implement it.

Parameters
out output by this transform

Protected Methods

protected String buildObjOptionValue (WebObjectInfo obj)

protected GGCalendar getCalendar ()

Returns a localized instance of Calendar component.
This object is used for creating an calendar HTML object used for entering date values.

Returns
  • calendar as a GGCalendar instance.

protected abstract List getDisplayStyleList (ArrayList list, String currentStyle)

protected WebProperty getProperty (String psName, String pName)

Throws
IllegalArgumentException
WebObjectsException

protected String getPropertyValue (String psName, String pName)