Class AbstractObjectExplorerTransform

    • Field Detail

      • ID_POSTFIX

        protected static final java.lang.String ID_POSTFIX
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • showCurrentInAncestorsList

        public FormalParameter showCurrentInAncestorsList
        Formal parameter: Inidcates whether to show the current item in the ancestors list
      • incrementalFetchPageBlock

        public FormalParameter incrementalFetchPageBlock
        Formal parameter: Indicates the number of pages to show per block for incremental fetch
      • displayFormatPickerName

        public FormalParameter displayFormatPickerName
        Indicates the id of a system picker that contains the possible display options for the data result
        Since:
        MicroStrategy Web 9.0.0
      • checkImage

        public FormalParameter checkImage
        Formal parameter: The icon to use to submit the parent folders select box in HTML mode. Used only in HTML mode. For DHTML mode, the CSS contains the image
        Since:
        MicroStrategy Web 9.0.0
      • FP_CHECK_IMAGE

        public static final java.lang.String FP_CHECK_IMAGE
        Name for the formal parameter: checkImage
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • FP_DISPLAY_FORMAT_PICKER_NAME

        public static final java.lang.String FP_DISPLAY_FORMAT_PICKER_NAME
        Constant specifying the name of the formal parameter for defining the id of a system picker that contains the possible display options. Value is displayFormatPickerId.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • FP_INCREMENTAL_FETCH_NAV_TYPE

        public static final java.lang.String FP_INCREMENTAL_FETCH_NAV_TYPE
        Constant specifying the name of the formal parameter for defining the navigation type for incremental fetch. Value is incrementalFetchNavigationType.
        Since:
        MicroStrategy Web 9.0.0
        See Also:
        Constant Field Values
      • _imgCheck

        protected java.lang.String _imgCheck
        Since:
        MicroStrategy Web 9.0.0
    • Constructor Detail

      • AbstractObjectExplorerTransform

        public AbstractObjectExplorerTransform()
    • Method Detail

      • isUseOptionTitle

        public boolean isUseOptionTitle()
      • setUseOptionTitle

        public void setUseOptionTitle​(boolean useTitle)
      • initializeImages

        public void initializeImages()
        Initializes the name of the images to use on this transform's output. For each one of the images defined to be displayed, the resource folder information is added to its path and file name as specified on the formal parameters for the images.
        Overrides:
        initializeImages in class AbstractAppTransform
        Since:
        MicroStrategy Web 9.0.0
      • getDescription

        public java.lang.String getDescription()
        Return description for this Transform.
        Specified by:
        getDescription in interface Transform
        Returns:
        description text.
      • renderAncestors

        public void renderAncestors​(MarkupOutput out)
        Renders a select box containing a list of the folder's ancestors
        Parameters:
        out - MarkupOutput
      • renderSearch

        public void renderSearch​(MarkupOutput out)
        Renders the search section of the component
        Parameters:
        out - MarkupOutput
      • renderSearchBox

        public void renderSearchBox​(MarkupOutput out)
        Renders the search box for the project browser
        Parameters:
        out - MarkupOutput
      • renderSearchButton

        public void renderSearchButton​(MarkupOutput out)
        Renders a Magnifier image as the search/filter button of the browser
        Parameters:
        out - MarkupOutput
      • renderSearchEventArgs

        protected void renderSearchEventArgs​(MarkupOutput out)
        Render hidden inputs for Search event arguments
      • getUnitAttributes

        public java.util.Map getUnitAttributes​(WebDisplayUnit du)
        Returns a map containing the attributes to add to the container of every object in the list of contents.
        Parameters:
        du - WebDisplayUnit
        Returns:
        Map
      • renderUnit

        public void renderUnit​(MarkupOutput out,
                               WebDisplayUnit du)
        Returns the give unit in the component's contents list.
        Parameters:
        out - MarkupOutput
        du - WebDisplayUnit
      • renderObjectCount

        public void renderObjectCount​(MarkupOutput out)
        Renders the total number of objects contianed by the component, regardless of any incremental fetch functionality
        Parameters:
        out - MarkupOutput
      • renderOpenParent

        public void renderOpenParent​(MarkupOutput out)
        Renders a link to the folder's parent
        Parameters:
        out - MarkupOutput
      • addOpenParentImg

        protected void addOpenParentImg​(Tag tag)
        Since:
        MicroStrategy Web 9.0.0
      • addOpenParentImg

        protected void addOpenParentImg​(Tag tag,
                                        boolean enabled)
        Since:
        MicroStrategy Web 9.0.0
      • renderHiddenInputs

        public void renderHiddenInputs​(MarkupOutput out)
        Renders the hidden inputs of the events that can be handled by the bean
        Parameters:
        out - MarkupOutput
      • getIncrementalFetchComponent

        protected IncrementalFetch getIncrementalFetchComponent()
        Generate and initialize the IncrementalFetch component that will enable navigating the different elements of the full list of results in case it is not displayed all together at the same time.
        Returns:
        IncrementalFetch initialized instance
        Since:
        MicroStrategy Web 9.0.0
      • getGoToArgument

        public int getGoToArgument()
        Since:
        MicroStrategy Web 9.0.0
      • getBlockPosition

        protected int getBlockPosition()
        Since:
        MicroStrategy Web 9.0.0
      • getBlockSize

        protected int getBlockSize()
        Since:
        MicroStrategy Web 9.0.0
      • getChildCount

        protected int getChildCount()
        Since:
        MicroStrategy Web 9.0.0
      • renderIncrementalFetch

        public void renderIncrementalFetch​(MarkupOutput out)
        Renders the incremental fetch section of the component
        Parameters:
        out - MarkupOutput
      • getExplorerClientSideHelper

        protected ClientSideHelper getExplorerClientSideHelper()
        Returns a the client side helper object that will be associated with the list ob objects to display. Note this is different from the getClientSideHelper() method which returns the ClientSideHelper instance for the entire component object.
        Returns:
        ClientSideHelper
      • getOption

        protected Tag getOption​(WebDisplayUnit du,
                                java.lang.String indent)
        Returns an option Tag containing the display unit provided.
        Parameters:
        du - WebDisplayUnit to open
        indent - String
      • getUnitName

        protected java.lang.String getUnitName​(WebDisplayUnit du)
        Renders only the name of the object passed as a parameter
        Parameters:
        du - WebDisplayUnit
      • getUnitDesc

        protected java.lang.String getUnitDesc​(WebDisplayUnit du)
        Get the
        Parameters:
        du - WebDisplayUnit
      • getAncestorsSelectTag

        protected SelectTag getAncestorsSelectTag()
        Returns a >select< Tag instance object containing the list\ of the object's ancestors
        Returns:
        SelectTag
      • shouldShowDummyFolderOption

        protected boolean shouldShowDummyFolderOption()
      • addCurrentFolderToAncestorList

        protected void addCurrentFolderToAncestorList​(SelectTag tag,
                                                      java.lang.StringBuffer indentBuffer)
      • addAncestorsOptionsToSelectTag

        protected java.lang.StringBuffer addAncestorsOptionsToSelectTag​(SelectTag tag)
      • getAncestorsOptionTags

        protected java.util.ArrayList getAncestorsOptionTags​(java.lang.StringBuffer indentBuffer)
      • getSearchBox

        protected Tag getSearchBox()
        Returns the search box for the project browser MarkupOutput
      • getSearchButton

        protected Tag getSearchButton()
        Returns a Magnifier image as the search/filter button of the browser MarkupOutput
      • getBrowseEvent

        protected WebEvent getBrowseEvent()
        Returns a new instance of the event use for browsing across objects
        Returns:
        WebEvent
      • getOKEvent

        protected WebEvent getOKEvent()
        Returns a new instance of the event use for the ok button
        Returns:
        WebEvent
      • getOpenParentEvent

        protected WebEvent getOpenParentEvent()
        Returns a new instance of the event use to go to open the object's parent
        Returns:
        WebEvent
      • getChangeDisplayFormatEvent

        protected WebEvent getChangeDisplayFormatEvent()
        Returns a new instance of the event use to toggle the display format
        Returns:
        WebEvent
        Since:
        MicroStrategy Web 9.0.0
      • getSearchEvent

        protected WebEvent getSearchEvent()
        Returns a new instance of the event use for searching objects in the Explorer
        Returns:
        WebEvent
      • getCssName

        protected abstract java.lang.String getCssName​(WebDisplayUnit du)
        Retruns the css class to use on the container of the object presented in the list of contents.
        Parameters:
        du - WebDisplayUnit
        Returns:
        String
      • getExplorerScriptClass

        protected java.lang.String getExplorerScriptClass()
        Returns the javaScript class (bone) associated with the content's list.
        Returns:
        String
      • getUnitAnchor

        protected AnchorTag getUnitAnchor​(WebDisplayUnit du)
        Returns an >a< Tag instance that will allow th euser to "open" the given unit in the component. This method is used in the component's contents list.
        Parameters:
        du - WebDisplayUnit
        Returns:
        AnchorTag
      • getHiddenInputsEventList

        protected java.util.ArrayList getHiddenInputsEventList()
        Returns the list of events that will be included in the hidden inputs section.
        Returns:
        ArrayList
      • renderDisplayFormatPickers

        public void renderDisplayFormatPickers​(MarkupOutput out)
        Method that renders the display format pickers
        Parameters:
        out - MarkupOutput instance where the HTML contents to render are to be saved.
        Since:
        MicroStrategy Web 9.0.0
      • renderChangeFormatDropDown

        public void renderChangeFormatDropDown​(MarkupOutput out)
        Method that renders the "show as" display option
        Parameters:
        out - MarkupOutput instance where the HTML contents to render are to be saved.
        Since:
        MicroStrategy Web 9.0.0
      • getForm

        protected Tag getForm​(Tag content)
        The method will check if the renderFOrm formal parameter is set to true, and if so it will create a new form tag, insert the contents passed as parameter and return the form. If the formal parameter is set to false, the method return the same tag passed as parameter.
        Parameters:
        content - Tag
        Returns:
        Tag
        Since:
        MicroStrategy Web 9.0.0
      • shouldGenerateNewForm

        protected boolean shouldGenerateNewForm()
        Since:
        MicroStrategy Web 9.0.0
      • shouldDisplayErrorMessage

        public boolean shouldDisplayErrorMessage()
        Since:
        MicroStrategy Web 9.0.0
      • renderErrorMessage

        public void renderErrorMessage​(MarkupOutput out)
        Since:
        MicroStrategy Web 9.0.0
      • getID

        public java.lang.String getID()
        This method overwrites its super implementation so that when assigning different styles to the same transform we get the same unique ID as long as the base bean stays the same
        Specified by:
        getID in interface Transform
        Overrides:
        getID in class AbstractAppTransform
        Returns:
        String the unqiue ID used by the place-holder DIV when doing iframe update.
        Since:
        MicroStrategy Web 9.0.0
      • renderLayeredIconInfo

        public void renderLayeredIconInfo​(MarkupOutput out,
                                          WebDisplayUnit unit)
        generate a SPAN tag which host background image and an inner SPAN for the layering effect in case an additional image has to be included on top of the original (for example, a shortcut arrow, a red error sign, etc).
        Parameters:
        out - MarkupOutput instance where to save the contents to display
        unit - WebDisplayUnit to be rendered.
        Since:
        MicroStrategy Web 9.0.0