Class ObjectBrowserTabProjectBrowserTransform

    • Field Detail

      • DISPLAY_LEVEL_CONTENTS_BODY_LIST

        public static final int DISPLAY_LEVEL_CONTENTS_BODY_LIST
        Deprecated.
        Value that can be used for the levelFlag for this transform to render the project browser contents list alone
        See Also:
        Constant Field Values
      • DISPLAY_LEVEL_CONTENTS_BODY_ANCESTORS

        public static final int DISPLAY_LEVEL_CONTENTS_BODY_ANCESTORS
        Deprecated.
        Value that can be used for the levelFlag for this transform to render the ancestors of the current folder as a select box
        See Also:
        Constant Field Values
      • DISPLAY_LEVEL_CONTENTS_BODY_SEARCH

        public static final int DISPLAY_LEVEL_CONTENTS_BODY_SEARCH
        Deprecated.
        Value that can be used for the levelFlag for this transform to render the project browser search box.
        See Also:
        Constant Field Values
      • DISPLAY_LEVEL_CONTENTS_BODY_INCREMENTAL_FETCH

        public static final int DISPLAY_LEVEL_CONTENTS_BODY_INCREMENTAL_FETCH
        Deprecated.
        Value that can be used for the levelFlag for this transform to render the incremental fetch for the project browser
        See Also:
        Constant Field Values
      • DISPLAY_LEVEL_CONTENTS_BODY_ALL

        public static final int DISPLAY_LEVEL_CONTENTS_BODY_ALL
        Deprecated.
        Value that can be used for the levelFlag for this transform to render all sections of the project browser (ancestors dropdown, search box, contents list, incremental fetch)
        See Also:
        Constant Field Values
      • folderUpImage

        public FormalParameter folderUpImage
        Deprecated.
        Formal parameter: Indicates the image to use for allowing the user to navigate one folder up in the hierarchy. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • searchImage

        public FormalParameter searchImage
        Deprecated.
        Formal parameter: Indicates the image to use for allowing the user to run a search. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgFirstPage

        public FormalParameter imgFirstPage
        Deprecated.
        Formal parameter: The image to use for the first page of the incremental fetch when active. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgFirstPageDisabled

        public FormalParameter imgFirstPageDisabled
        Deprecated.
        Formal parameter: The image to use for the first page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgPreviousPage

        public FormalParameter imgPreviousPage
        Deprecated.
        Formal parameter: The image to use for the previous page of the incremental fetch. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgPreviousPageDisabled

        public FormalParameter imgPreviousPageDisabled
        Deprecated.
        Formal parameter: The image to use for the previous page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgNextPage

        public FormalParameter imgNextPage
        Deprecated.
        Formal parameter: The image to use for the next page of the incremental fetch when active. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgNextPageDisabled

        public FormalParameter imgNextPageDisabled
        Deprecated.
        Formal parameter: The image to use for the next page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgLastPage

        public FormalParameter imgLastPage
        Deprecated.
        Formal parameter: The image to use for the last page of the incremental fetch when active. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • imgLastPageDisabled

        public FormalParameter imgLastPageDisabled
        Deprecated.
        Formal parameter: The image to use for the last page of the incremental fetch when inactive. Used only in HTML mode. For DHTML mode, the CSS contains the image
      • checkImage

        public FormalParameter checkImage
        Deprecated.
        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
      • folderJS

        public FormalParameter folderJS
        Deprecated.
        Formal parameter: The javascript function to execute when you click on a folder
      • incrementalFetchJS

        public FormalParameter incrementalFetchJS
        Deprecated.
        Formal parameter: The javascript function to execute when you click on the incremental fetch links
      • folderUpJS

        public FormalParameter folderUpJS
        Deprecated.
        Formal parameter: The javascript function to execute when you click on the image that takes you up a level in the folder structure.
      • levelChangeJS

        public FormalParameter levelChangeJS
        Deprecated.
        Formal parameter: The javascript function to execute when you change the folder level
      • searchJS

        public FormalParameter searchJS
        Deprecated.
        Formal parameter: The javascript function to execute when you click on the search image button
      • FP_IMAGE_LAST_PAGE

        public static final java.lang.String FP_IMAGE_LAST_PAGE
        Deprecated.
        Name for the formal parameter: imgLastPage
        See Also:
        Constant Field Values
      • FP_IMAGE_NEXT_PAGE

        public static final java.lang.String FP_IMAGE_NEXT_PAGE
        Deprecated.
        Name for the formal parameter: imgNextPage
        See Also:
        Constant Field Values
      • FP_IMAGE_FIRST_PAGE

        public static final java.lang.String FP_IMAGE_FIRST_PAGE
        Deprecated.
        Name for the formal parameter: imgFirstPage
        See Also:
        Constant Field Values
      • FP_CHECK_IMAGE

        public static final java.lang.String FP_CHECK_IMAGE
        Deprecated.
        Name for the formal parameter: checkImage
        See Also:
        Constant Field Values
      • FP_LEVEL_FLAG

        public static final java.lang.String FP_LEVEL_FLAG
        Deprecated.
        Name for the formal parameter: levelFlag
        See Also:
        Constant Field Values
      • FP_FOLDER_JS

        public static final java.lang.String FP_FOLDER_JS
        Deprecated.
        Name for the formal parameter: folderJS
        See Also:
        Constant Field Values
      • FP_FOLDER_UP_JS

        public static final java.lang.String FP_FOLDER_UP_JS
        Deprecated.
        Name for the formal parameter: folderUpJS
        See Also:
        Constant Field Values
      • FP_SEARCH_JS

        public static final java.lang.String FP_SEARCH_JS
        Deprecated.
        Name for the formal parameter: searchJS
        See Also:
        Constant Field Values
      • cssFileSearch

        protected java.lang.String cssFileSearch
        Deprecated.
        The className for the search text box
      • cssBody

        protected java.lang.String cssBody
        Deprecated.
        The className for the body of the project browser contents
    • Constructor Detail

      • ObjectBrowserTabProjectBrowserTransform

        public ObjectBrowserTabProjectBrowserTransform()
        Deprecated.
        Default constructor for the transform. Adds all the formal parameters to the transform
    • Method Detail

      • renderContextMenu

        public void renderContextMenu​(MarkupOutput out)
        Deprecated.
        This method is for rendering the context menus. By default there are no context menus The context menus for the report object browser are rendered in ReportAllObjectsTransform
        Parameters:
        out - MarkupOutput
      • renderObjectCount

        public void renderObjectCount​(MarkupOutput out)
        Deprecated.
        This method render the section that displays the number of objects found. Used for the report - all objects tab of the object browser
        Parameters:
        out - MarkupOutput
      • renderObjectList

        public void renderObjectList​(MarkupOutput out)
        Deprecated.
        Renders the list of objects for the current folder/search results whose contents is being displayed in DHTML mode. Also renders all the folderLinks that has been configured using the objBrowserFolderLinks.xml file
        Parameters:
        out - MarkupOutput
      • renderFolderObject

        protected void renderFolderObject​(MarkupOutput out,
                                          WebObjectInfo objectInfo,
                                          boolean isFolderLink)
        Deprecated.
        Renders each folder as part of the contents of the project browser in DHTML mode
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
        isFolderLink - Boolean Whether the folder is a folderLink or not
      • renderFolderObject

        protected void renderFolderObject​(MarkupOutput out,
                                          WebObjectInfo objectInfo,
                                          boolean isFolderLink,
                                          java.lang.String className)
        Deprecated.
        Renders each folder as part of the contents of the project browser in DHTML mode
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
        isFolderLink - Boolean Whether the folder is a folderLink or not
        className - String
      • renderSingleObject

        protected void renderSingleObject​(MarkupOutput out,
                                          WebObjectInfo objectInfo)
        Deprecated.
        Renders each non-folder objects as part of the contents of the project browser bean in DHTML mode
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
      • renderSingleObject

        protected void renderSingleObject​(MarkupOutput out,
                                          WebObjectInfo objectInfo,
                                          java.lang.String className)
        Deprecated.
        Renders each non-folder objects as part of the contents of the project browser bean in DHTML mode
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
        className - String
      • renderAttributeObject

        protected void renderAttributeObject​(MarkupOutput out,
                                             WebObjectInfo objectInfo)
        Deprecated.
        Renders each object that is of type EnumDSSXMLObjectTypes.DssXmlTypeAttribute as part of the contents of the project browser bean in DHTML mode
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
      • renderAttributeObject

        protected void renderAttributeObject​(MarkupOutput out,
                                             WebObjectInfo objectInfo,
                                             java.lang.String className)
        Deprecated.
        Renders each object that is of type EnumDSSXMLObjectTypes.DssXmlTypeAttribute as part of the contents of the project browser bean in DHTML mode
        Parameters:
        out - MarkupOutput
        objectInfo - WebObjectInfo
        className - String
      • renderIncrementalFetch

        public void renderIncrementalFetch​(MarkupOutput out)
        Deprecated.
        Renders the incremental fetch section in DHTML mode
        Parameters:
        out - MarkupOutput
      • displayIncrementalFetchArrow

        protected void displayIncrementalFetchArrow​(MarkupOutput out,
                                                    int pageNumber,
                                                    java.lang.String imageCss,
                                                    java.lang.String alt)
        Deprecated.
        Renders the incremental fetch arrow in DHTML mode
        Parameters:
        out - MarkupOutput
        pageNumber - Integer
        imageCss - String
        alt - String Tooltip for the image
      • renderSearchSection

        public void renderSearchSection​(MarkupOutput out)
        Deprecated.
        Renders the search section of the project browser in DHTML mode
        Parameters:
        out - MarkupOutput
      • renderGlobalEventsInformation

        public void renderGlobalEventsInformation​(MarkupOutput out)
        Deprecated.
        Render extra event information, for events that some one else might trigger
        Parameters:
        out - MarkupOutput
      • renderAncestorInformation

        public void renderAncestorInformation​(MarkupOutput out)
        Deprecated.
        Renders the ancestors of the current folder in the form of a 'SELECT' box Used in DHTML mode only.
        Parameters:
        out - MarkupOutput
      • getDescription

        public java.lang.String getDescription()
        Deprecated.
        Returns the textual description of the transform
        Returns:
        the description of the transform
      • initializeCss

        public void initializeCss()
        Deprecated.
        Initializes the Css Classes to use. For each one of the css classes to use, the prefix indicated on the formal parameter is added to the name of the class to use.
        Overrides:
        initializeCss in class AbstractAppTransform
      • initializeImages

        public void initializeImages()
        Deprecated.
        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 AbstractObjectBrowserTabTransform
      • getSearchEvent

        protected WebEvent getSearchEvent()
        Deprecated.
        Returns the web event to run a search
        Returns:
        WebEvent
      • getFolderNavigateEvent

        protected WebEvent getFolderNavigateEvent()
        Deprecated.
        Returns the web event to navigate a folder
        Returns:
        WebEvent
      • getEvent

        protected WebEvent getEvent​(WebObjectInfo object,
                                    int objectType)
        Deprecated.
        Get events based on the WebObjectInfo (to initialize) or only for the requested object type (not initialized)
        Parameters:
        object - WebObjectInfo
        objectType - Integer
        Returns:
        WebEvent
      • getFolderNavigateEvent

        protected WebEvent getFolderNavigateEvent​(WebObjectInfo folderObject)
        Deprecated.
        Returns the web event to navigate a folder
        Parameters:
        folderObject - WebObjectInfo
        Returns:
        WebEvent
      • getGoToParentEvent

        protected WebEvent getGoToParentEvent​(java.lang.String parentFolderID)
        Deprecated.
        Returns the event for navigating to the parent folder
        Parameters:
        parentFolderID - identifier of the folder where to go to
        Returns:
        WebEvent instance initialized for requesting the navigation to the parent of the current folder.
      • getIncrementalFetchEvent

        protected WebEvent getIncrementalFetchEvent​(int newPage)
        Deprecated.
        Returns the event to do incremental fetch
        Parameters:
        newPage - index number of the page where to go to
        Returns:
        WebEvent instance intitialized with the information for requesting a page navigation
      • generateAnchor

        protected AnchorTag generateAnchor​(WebEvent event)
        Deprecated.
        Overwrites the parent method by setting special attributes if the event is not provided
        Overrides:
        generateAnchor in class AbstractAppTransform
        Parameters:
        event - WebEvent
        Returns:
        AnchorTag