Package com.microstrategy.web.app.transforms

Class AbstractPromptEditorTransform

    • Field Detail

      • imgCalendar

        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.

      • _imagesFolder

        protected java.lang.String _imagesFolder
        Indicates images folder path.

    • Constructor Detail

      • AbstractPromptEditorTransform

        public AbstractPromptEditorTransform()

    • Method Detail

      • initializeTransform

        public void initializeTransform​(Transformable data)
        Description copied from class: AbstractAppTransform

        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.
        Specified by:
        initializeTransform in interface AppTransform
        Overrides:
        initializeTransform in class AbstractAppTransform
        Parameters:
        data - the bean to transform.

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Description copied from class: AbstractAppTransform
        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;
    }

 }
        Specified by:
        getSupportedBeanType in interface Transform
        Overrides:
        getSupportedBeanType in class AbstractAppTransform
        Returns:
        a root class/interface supported by this transform.

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: Transform
        Returns a textual description of the transform.
        Specified by:
        getDescription in interface Transform
        Returns:
        The textual description of the transform.

      • addCheckedAttr

        public java.util.Map addCheckedAttr()
        Add checked attribute into the attribute map.

      • addTitleAsValue

        public java.util.Map addTitleAsValue()
        Add the title of the prompt as a value attribute into the attribute map.

      • addNameAsValue

        public java.util.Map addNameAsValue()

      • addWidthAsValue

        public java.util.Map addWidthAsValue​(java.lang.String max)

      • addHeightAsValue

        public java.util.Map addHeightAsValue​(java.lang.String max)

      • addArrangeSizeAsValue

        public java.util.Map addArrangeSizeAsValue()

      • isArrangementSizeNonDefault

        public boolean isArrangementSizeNonDefault()

      • addMaxElemPerSubAsValue

        public java.util.Map addMaxElemPerSubAsValue()

      • isMaxElemPerSubNonDefault

        public boolean isMaxElemPerSubNonDefault()

      • renderDescription

        public void renderDescription​(MarkupOutput out)
        Render the description into the output stream.
        Parameters:
        out -

      • getPersonalAnswersAllowedList

        public java.util.List getPersonalAnswersAllowedList()
        Return a list of allowed personal answers.

      • getDisplayStyles

        public java.util.List getDisplayStyles()

      • getDisplayStyleList

        protected abstract java.util.List getDisplayStyleList​(java.util.ArrayList list,
                                                      java.lang.String currentStyle)

      • getArrangementList

        public java.util.List getArrangementList()

      • getColFillOrderList

        public java.util.List getColFillOrderList()

      • addMinValueAttr

        public java.util.Map addMinValueAttr()
        Add minimum value as a value attribute.

      • addMaxValueAttr

        public java.util.Map addMaxValueAttr()
        Add maximum value as a value attribute.

      • hasMin

        public boolean hasMin()
        Returns whether the prompt has a minimum value.

      • hasMax

        public boolean hasMax()
        Returns whether the prompt has a maximum value.

      • isRequired

        public boolean isRequired()
        Returns whether the prompt require an answer.

      • addAttr

        public java.util.Map addAttr​(java.lang.String attName,
                             java.lang.String attValue)
        Adds an attribute, whose attribute name is attName and whose value is attValue.
        Parameters:
        attName -
        attValue -

      • renderText

        public void renderText​(MarkupOutput out,
                       java.lang.String text)
        Render a text into output stream.
        Parameters:
        out -
        text -

      • isFixedWidth

        public boolean isFixedWidth()

      • isFixedHeight

        public boolean isFixedHeight()

      • getShowSearchBoxPropValues

        public java.util.List getShowSearchBoxPropValues()

      • isUseFolderStructure

        public boolean isUseFolderStructure()

      • isDonotShowEmptyFolders

        public boolean isDonotShowEmptyFolders()

      • isUseWebBlocks

        public boolean isUseWebBlocks()

      • isSearchRequired

        public boolean isSearchRequired()

      • isAllowNavigateAbove

        public boolean isAllowNavigateAbove()

      • isAllowOpChange

        public boolean isAllowOpChange()

      • isAllowFullExpChange

        public boolean isAllowFullExpChange()

      • isOnlyAllowRootOpChange

        public boolean isOnlyAllowRootOpChange()

      • isAllowRootOpChange

        public boolean isAllowRootOpChange()

      • isAllowInterOpChange

        public boolean isAllowInterOpChange()

      • isAllowElementImport

        public boolean isAllowElementImport()

      • isAllowElementBrowse

        public boolean isAllowElementBrowse()

      • isDispOuputLevelSelector

        public boolean isDispOuputLevelSelector()

      • addDisableObjs

        public java.util.Map addDisableObjs​(java.lang.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.
        Parameters:
        objs -

      • getCalendar

        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.

      • isExpressionPrompt

        public boolean isExpressionPrompt()

      • isHierarchyPrompt

        public boolean isHierarchyPrompt()

      • isElementPrompt

        public boolean isElementPrompt()

      • isSearchRequiredAvailable

        public boolean isSearchRequiredAvailable()

      • isDateRangeAvailable

        public boolean isDateRangeAvailable()

      • isAttributeQualificationPrompt

        public boolean isAttributeQualificationPrompt()

      • isMetricQualificationPrompt

        public boolean isMetricQualificationPrompt()

      • buildObjOptionValue

        protected java.lang.String buildObjOptionValue​(WebObjectInfo obj)

      • showUserAnswerRestriction

        public boolean showUserAnswerRestriction()

      • isProjectLevelUserAnswerAllowed

        public boolean isProjectLevelUserAnswerAllowed()

      • showBackwardCompatibility

        public boolean showBackwardCompatibility()

      • addBackwardDisplay

        public java.util.Map addBackwardDisplay()

      • renderUnitsLabel

        public void renderUnitsLabel​(MarkupOutput mo)

      • isPre90CustomStyle

        public boolean isPre90CustomStyle()

      • addPre90StyleAsValue

        public java.util.Map addPre90StyleAsValue()

      • renderCalendar

        public void renderCalendar​(MarkupOutput out,
                           java.lang.String textBoxName,
                           java.lang.String calendarArg,
                           java.lang.String maxRestrictionName,
                           java.lang.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.

      • renderTimePicker

        public void renderTimePicker​(MarkupOutput out,
                             java.lang.String pickerFieldsName,
                             java.lang.String onChangeEvent,
                             java.lang.String hourPickerName,
                             java.lang.String minPickerName,
                             java.lang.String secPickerName,
                             java.lang.String dependField)