Package com.microstrategy.web.app.transforms

Class ObjectPathTransform

    • Field Detail

      • LEVEL_LINE_BEFORE_LAST

        public static final int LEVEL_LINE_BEFORE_LAST
        Deprecated.
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display a new line character before the last item on the path. One of its main uses is in the Yahoo Path view where, for example, on the Folder page the path is shown in one line, and it places the current folder name (last element) on a separate line.
        Value = 1
        See Also:
        Constant Field Values

      • LEVEL_OPEN_FOLDER_IMAGE

        public static final int LEVEL_OPEN_FOLDER_IMAGE
        Deprecated.
        Allowed value for the levelFlag formal parameter. Specifies that the transform will display an image before the object name which represents the current one being viewed, as defined on the openFolderImage formal parameter.
        Value = 2
        See Also:
        Constant Field Values

      • LEVEL_HOME_LINK

        public static final int LEVEL_HOME_LINK
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Specifies that the transform will render as part of the path, a link for Home application page.
        Value = 4
        See Also:
        Constant Field Values

      • LEVEL_DESKTOP_LINK

        public static final int LEVEL_DESKTOP_LINK
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Specifies that the transform will show a link for the project's Desktop page as part of the path.
        Value = 8
        See Also:
        Constant Field Values

      • LEVEL_ITEM_LINK

        public static final int LEVEL_ITEM_LINK
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Specifies that the transform will render the current item inside a link.
        Value = 16
        See Also:
        Constant Field Values

      • LEVEL_TITLE

        public static final int LEVEL_TITLE
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Specifies that the transform will render a Title ("You are here: " label) before displaying the path.
        Value = 32
        See Also:
        Constant Field Values

      • LEVEL_LINKS

        public static final int LEVEL_LINKS
        Deprecated.
        please use the showLink Formal Paramter
        Allowed value for the levelFlag formal parameter. Determines if each one of the items rendered by the transform as part of the path will be inside links. Value = 64
        See Also:
        Constant Field Values

      • LEVEL_ANCESTORS_PATH

        public static final int LEVEL_ANCESTORS_PATH
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Determines if ancestors folder path gets displayed. Value = 128
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • LEVEL_ALL

        public static final int LEVEL_ALL
        Deprecated.
        please use the layout xml
        Allowed value for the levelFlag formal parameter. Convenience flag for selecting all the possible level flag values defined on this class.
        Value = -1
        See Also:
        Constant Field Values

      • showLink

        public FormalParameter showLink
        Deprecated.
        Indicates whether the object path contains a hyperlink to that object
        Default value is boolean TRUE which indicates the hyperlinks will be generated for each object path.
        Since:
        MicroStrategy Web 8.0.1

      • levelFlag

        public FormalParameter levelFlag
        Deprecated.
        please use the layout xml
        Indicates the level of information to use when displaying each item.
        The information may be displayed as links. The value to assign to this formal parameter should be a bitwise flag combining constants such as LEVEL_ITEM_LINK, LEVEL_TITLE, etc. For a complete list, refer to ObjectPathTransform.
        Usage: If only the title and the current object shall be displayed, the flag value to assign to the formal parameter would be 80 (16 + 64). Default value is LEVEL_ALL

      • dividerCharacters

        public FormalParameter dividerCharacters
        Deprecated.
        Indicates the character(s) to be used for separating each one of the different elements when displaying the path.
        These characters will be displayed after each element except the last one, for indicating a hierarchy between the folders shown.
        Usage: Default value is >. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.

      • hiddenFolderCharacters

        public FormalParameter hiddenFolderCharacters
        Deprecated.
        Indicates the character(s) to be used as placeholders when displaying a hidden folder inside the path.
        These characters will be displayed instead of the hidden folder name without link associated with it since the user does not have enough privileges for accessing it. If there are two or more hidden folders one after the other, these characters will be displayed only once. Usage: Default value is [ ...]. The value to assign to this formal parameter has to be HTML compatible for it to be displayed correctly on the final HTML page.

      • extraItemNameHREFAnchorInfo

        public FormalParameter extraItemNameHREFAnchorInfo
        Deprecated.
        Please customize the generated link instead
        Indicates any extra information that will be rendered as attributes of the Anchor tag.
        Any valid anchor tag attributes and their values might be specified here. This formal parameter is mainly for associating javascript method calls (in which case previous validation is done to confirm the page is being rendered in DHTML mode).

      • isSelfContained

        public FormalParameter isSelfContained
        Deprecated.
        Indicates if the current object being transformed should be used when generating the events that will be used for creating the links for accessing other folders.
        Default value is boolean TRUE which indicates this object will be the source for the links to render.

      • openFolderImage

        public FormalParameter openFolderImage
        Deprecated.
        Indicates the image to use before displaying the current object on the path (if requested on the levelFlag formal parameter).
        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.

      • FP_SHOW_LINK

        public static final java.lang.String FP_SHOW_LINK
        Deprecated.
        Constant specifying the name of the formal parameter for defining the showLink. Value is showLink .
        Since:
        MicroStrategy Web 8.0.1
        See Also:
        Constant Field Values

      • FP_LEVEL_FLAG

        public static final java.lang.String FP_LEVEL_FLAG
        Deprecated.
        Constant specifying the name of the formal parameter for defining the level flag. Value is levelFlag.
        See Also:
        Constant Field Values

      • FP_CHARS_FOR_DIVIDER

        public static final java.lang.String FP_CHARS_FOR_DIVIDER
        Deprecated.
        Constant specifying the name of the formal parameter for defining the dividing characters in between objects in the path. Value is dividerCharacters.
        See Also:
        Constant Field Values

      • FP_CHARS_FOR_HIDDEN_FOLDERS

        public static final java.lang.String FP_CHARS_FOR_HIDDEN_FOLDERS
        Deprecated.
        Constant specifying the name of the formal parameter for defining the characters to use instead of the names of folders that are hidden for the user. Value is hiddenFolderCharacters.
        See Also:
        Constant Field Values

      • FP_EXTRA_ANCHOR_INFO

        public static final java.lang.String FP_EXTRA_ANCHOR_INFO
        Deprecated.
        Constant specifying the name of the formal parameter for defining the extra attributes to be added to the anchor to generate. Value is extraItemNameHREFAnchorInfo.
        See Also:
        Constant Field Values

      • FP_OPEN_FOLDER_IMAGE

        public static final java.lang.String FP_OPEN_FOLDER_IMAGE
        Deprecated.
        Constant specifying the name of the formal parameter for defining the image to render before the current object is displayed. Value is openFolderImage.
        See Also:
        Constant Field Values

      • FP_IS_SELF_CONTAINED

        public static final java.lang.String FP_IS_SELF_CONTAINED
        Deprecated.
        Constant specifying the name of the formal parameter for defining if the object is self contained or not. Value is isSelfContained.
        See Also:
        Constant Field Values

      • cssItemNameCache

        protected java.lang.String cssItemNameCache
        Deprecated.

      • cssUnselectedItemNameCache

        protected java.lang.String cssUnselectedItemNameCache
        Deprecated.

      • _showLink

        protected boolean _showLink
        Deprecated.

      • _objectName

        protected java.lang.String _objectName
        Deprecated.

      • _event

        protected WebEvent _event
        Deprecated.

    • Constructor Detail

      • ObjectPathTransform

        public ObjectPathTransform()
        Deprecated.
        Default constructor, initialize formal parameters.

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Return description for this Transform
        Specified by:
        getDescription in interface Transform
        Returns:
        description for the transform

      • renderContent

        public void renderContent​(MarkupOutput out)
        Deprecated.
        This is the main entry point of the Transform when no layout is specified. It displays the path of the folder with a link to each one of its ancestors, i.e.:
        Home > VMall > Shared Reports
        Parameters:
        out - MarkupOutput
        Since:
        MicroStrategy Web 8.0.0

      • renderTitle

        public void renderTitle​(MarkupOutput out)
        Deprecated.
        Renders the title, uses descriptor 51: You are here:
        Parameters:
        out - the transform's output

      • renderLinkForHome

        public void renderLinkForHome​(MarkupOutput out)
        Deprecated.
        Renders the link to Home, it uses the openHomeEvent for this.
        Parameters:
        out - the transform's output

      • renderLinkForDesktop

        public void renderLinkForDesktop​(MarkupOutput out)
        Deprecated.
        Renders the link the Desktop (start) page.
        Parameters:
        out - the transform's output

      • getAncestorFolder

        public WebFolder getAncestorFolder()
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • renderAncestors

        public void renderAncestors​(MarkupOutput out)
        Deprecated.
        please use the layout xml
        Renders the list of ancestors.
        Parameters:
        out - the transform's output

      • renderCurrentItem

        public void renderCurrentItem​(MarkupOutput out)
        Deprecated.
        Renders the curent item
        Parameters:
        out - the transform's output

      • initializeImages

        public void initializeImages()
        Deprecated.
        Initialize images, basically it prefix them with the global folderName
        Overrides:
        initializeImages in class AbstractAppTransform

      • getParentFolderBean

        public FolderBean getParentFolderBean()
        Deprecated.
        Retrieves the ObjectBean's parent FolderBean. This is the Bean from where we need to get the ancestors from.
        Returns:
        the parent's folder bean

      • getAncestors

        public SimpleList getAncestors()
        Deprecated.
        Retrieves the ObjectBean's parent FolderBean. This is the Bean from where we need to get the ancestors from.
        Returns:
        the parent's folder bean

      • getSupportedBeanType

        public java.lang.Class getSupportedBeanType()
        Deprecated.
        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.

      • getHasAncestors

        public boolean getHasAncestors()
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • setHasAncestors

        public void setHasAncestors​(boolean value)
        Deprecated.
        Since:
        MicroStrategy Web 8.0.0

      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Deprecated.
        Overwrites the parent method by setting the right event element value according to the formal parameters available on the transform
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent
        Returns:
        AnchorTag
        Since:
        MicroStrategy Web 8.0.0

      • getOpenHomeEvent

        protected WebEvent getOpenHomeEvent()
        Deprecated.
        Returns the open home event.
        Returns:
        The EnumServletEvents.WebEventOpenHome event.

      • getOpenDesktopEvent

        protected WebEvent getOpenDesktopEvent()
        Deprecated.
        Returns the open desktop event.
        Returns:
        The EnumServletEvents.WebEventOpenDesktop event.

      • getBrowseFolderEvent

        protected WebEvent getBrowseFolderEvent​(WebFolder folder)
        Deprecated.
        Returns the browser folder event.
        Parameters:
        folder - the folder to browse
        Returns:
        The EnumFolderBeanEvents.FOLDER_EVENT_BROWSE event.

      • getSysFolderID

        protected int getSysFolderID()
        Deprecated.
        Returns the system folder ID (NamedFolder) that is in the hierarchy of the object bean
        Returns:
        String EnumDSSXMLFolderNames value.
        Since:
        MicroStrategy Web 8.0.0

      • renderFolder

        protected void renderFolder​(MarkupOutput out,
                            WebFolder folder,
                            SimpleList ancestors,
                            int currentAncestor,
                            boolean showLink)
        Deprecated.
        Render a specific folder. This is a recursive function that calls itself to render the parent.
        It calls recursively until it finds the root folder. If the LEVEL_DESKTOP_LINK level is set, instead of stopping in the root folder, it stops in its first child.
        Parameters:
        out - the transform's output
        folder - the current folder
        ancestors - the list of ancestors
        currentAncestor - the index of this folder in the list of ancestors
        showLink - whether to render a link for the folder.

      • renderSimpleLink

        protected void renderSimpleLink​(MarkupOutput out,
                                WebEvent event,
                                java.lang.String descriptor,
                                java.lang.String css,
                                boolean showLink)
        Deprecated.
        Renders a link based on the event.
        Parameters:
        out - the transform's output
        event - the event associated witht he link
        descriptor - the content of the link
        css - the class to use
        showLink - whether to render to link or not (if false, the descriptor will be simply rendered within a SPAN tag).

      • checkLevel

        protected boolean checkLevel​(int iLevelConst)
        Deprecated.
        check if the level parameter value contains this flag
        Parameters:
        iLevelConst - level flag
        Returns:
        true means the level flag is included in the level parameter value

      • getObjectBean

        protected ObjectBean getObjectBean()
        Deprecated.
        Get the objectBean target of this transform
        Returns:
        the FolderBean instance used with this transform

      • useParentAncestors

        protected boolean useParentAncestors()
        Deprecated.

      • renderNewLine

        public void renderNewLine​(MarkupOutput out)
        Deprecated.
        Renders a new list before the item's name. This might be controlled through a formal parameter
        Parameters:
        out - the transform's output

      • renderOpenFolderImage

        public void renderOpenFolderImage​(MarkupOutput out)
        Deprecated.
        Renders the open folder image.
        Parameters:
        out - the transform's output

      • getSpecialFolderName

        protected java.lang.String getSpecialFolderName​(WebFolder folder)
        Deprecated.
        Check for special folders, if found one, return the descriptor. It also checks if the Shared Reports folder, using preferences, has been specified as other folder.
        Parameters:
        folder - the folder to check
        Returns:
        a String with the descriptor to use if it's a special folder, null otherwise.