Class ExplorerHandler

  • All Implemented Interfaces:
    com.jalios.jcms.JcmsConstants, com.jalios.util.JaliosConstants

    public class ExplorerHandler
    extends com.jalios.jcms.context.JcmsJspContext
    ExplorerHandler is a JavaBean which retrieve and update an Explorer instance. Invoke ExplorerHandler JavaBean to :
    • 1. Retrieve an explorer instance
      • Either by retrieving an existing Explorer from session attribute (if the request parameter "exId" has been specified)
      • Or else, creates an Explorer (if it could not be found in session and if allowed by the 'create' parameter of this bean).
        If an ExplorerConfiguration has been position in request attribute it is used by the newly create Explorer, otherwise a default config is used
    • 2. Read request parameters and apply them to the Explorer found in step 1
    Version:
    $Revision$
    Author:
    Olivier Jaquemet
    • Field Summary

      • Fields inherited from class com.jalios.jcms.context.JcmsJspContext

        AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, REVISION, SHOW_EDIT_ICON, STYLE_HEADER
      • Fields inherited from class com.jalios.jcms.context.JcmsContext

        browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspace
      • Fields inherited from interface com.jalios.util.JaliosConstants

        CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR
      • Fields inherited from interface com.jalios.jcms.JcmsConstants

        ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML
    • Constructor Summary

      Constructors 
      Constructor Description
      ExplorerHandler()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Explorer getExplorer()
      Retrieves the Explorer instance managed by this handler.
      boolean isAjaxRequest()
      Checks if the current request is an ajax request or if it is a the 'first' request used to create/init the explorer.
      void setExAjax​(boolean isAjax)
      Defines if this request is an ajax request or not.
      void setExCatMode​(java.lang.String catMode)
      Sets the category refinement mode to use.
      void setExCids​(java.lang.String cids)
      Sets all the categories to be used for refinement
      void setExDocumentKinds​(java.lang.String[] documentKinds)
      Sets the document kind refinement to use in the Explorer
      void setExFields​(java.lang.String[] fields)
      Sets the fields that should be displayed in explorer view.
      void setExFieldsState​(java.lang.String fieldsState)
      Sets whether fields pane should be displayed, collapsed, or hidden.
      void setExId​(java.lang.String exId)
      Sets the Explorer id that will be manipulated by this handler.
      A call to this method with a valid ID is required for this handler to be useful.
      void setExNavigationState​(java.lang.String navigationState)
      Sets whether navigation pane should be displayed, collapsed, or hidden.
      void setExOcids​(java.lang.String ocids)
      Sets the categories to open in the TreeCat
      void setExpagerAll​(boolean pagerAll)  
      void setExpageSize​(int pageSize)  
      void setExPreviewId​(java.lang.String previewId)
      Sets the id of the Publication to preview in the explorer
      void setExPstatus​(java.lang.String[] pstatus)
      Sets the pstatus to use for refinement in the Explorer
      void setExreverse​(boolean v)  
      void setExSearchInFiles​(boolean searchInFiles)
      Sets whether to perform search in files or not
      void setExSearchOptionsState​(java.lang.String searchOptionsState)
      Sets whether search options pane should be displayed, collapsed, or hidden.
      void setExShowInvisiblePubs​(boolean showInvisiblePubs)
      Sets whether to display invisible publication or not
      void setExShowSidebar​(boolean showSidebar)
      Sets whether sidebar is visible or not
      void setExsort​(java.lang.String sort)  
      void setExSrc​(java.lang.String src)
      Sets the new source to be used by the Explorer
      void setExstart​(int start)  
      void setExText​(java.lang.String text)
      Sets the text to search
      void setExTypes​(java.lang.String[] types)
      Sets the type refinement to be use in the Explorer
      void setExViewMode​(java.lang.String viewMode)
      Sets the new view mode value to be use by the Explorer.
      void setExWrkspc​(java.lang.String wrkspcId)
      Sets the workspace to be used by explorer for refinement
      boolean validate​(boolean create)
      Compute and update the Explorer being worked on base on request parameters set by this Handler.
      • Methods inherited from class com.jalios.jcms.context.JcmsJspContext

        addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addPrefetchHeader, addStyleHeader, addStyleHeader, addWebAssets, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptSet, getJSONBridge, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIcon, workaroundBrowserBaseHrefBug
      • Methods inherited from class com.jalios.jcms.context.JcmsContext

        addCookie, addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFile, getUploadedFileList, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, getWorkspace, glp, isAdmin, isAdminZone, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ExplorerHandler

        public ExplorerHandler()
    • Method Detail

      • validate

        public boolean validate​(boolean create)
        Compute and update the Explorer being worked on base on request parameters set by this Handler.
        Parameters:
        create - true to create a new Explorer instance if no Explorer could be found from the exId parameter, false to skip processing.
        Returns:
        true if the validation was successful, false otherwise (in the later case, not other operation on the handler should be performed)
      • getExplorer

        public Explorer getExplorer()
        Retrieves the Explorer instance managed by this handler.
        This method MUST be called after a call to the validate method which performs the retrieval of the Explorer based on the exId request parameter (or the creation of a new Explorer if create parameter has been set to true).
        Returns:
        the Explorer instance or null if the explorer could not be found
      • isAjaxRequest

        public boolean isAjaxRequest()
        Checks if the current request is an ajax request or if it is a the 'first' request used to create/init the explorer. Default value is false, unless modified by setExAjax(boolean).
        Overrides:
        isAjaxRequest in class com.jalios.jcms.context.JcmsContext
        Returns:
        true if the request is ajax, false otherwise
      • setExAjax

        public void setExAjax​(boolean isAjax)
        Defines if this request is an ajax request or not. Default value is false.
        Parameters:
        isAjax - true to inform that this request is an ajax request
      • setExId

        public void setExId​(java.lang.String exId)
        Sets the Explorer id that will be manipulated by this handler.
        A call to this method with a valid ID is required for this handler to be useful.
        Parameters:
        exId - the Explorer ID
      • setExViewMode

        public void setExViewMode​(java.lang.String viewMode)
        Sets the new view mode value to be use by the Explorer.
        Parameters:
        viewMode - the new view mode value to use, from ExplorerUtils.getAvailableViewModes()
      • setExSrc

        public void setExSrc​(java.lang.String src)
        Sets the new source to be used by the Explorer
        Parameters:
        src - a source from ExplorerUtils.getAvailableSrc()
      • setExWrkspc

        public void setExWrkspc​(java.lang.String wrkspcId)
        Sets the workspace to be used by explorer for refinement
        Parameters:
        wrkspcId - a Workspace ID or anyhing else to reset workspace refinement
      • setExCatMode

        public void setExCatMode​(java.lang.String catMode)
        Sets the category refinement mode to use.
        Parameters:
        catMode - a string indicating the mode to use, choosen from "one", "and", "or".
      • setExCids

        public void setExCids​(java.lang.String cids)
        Sets all the categories to be used for refinement
        Parameters:
        cids - an string with Categories' id seperated with comma
      • setExOcids

        public void setExOcids​(java.lang.String ocids)
        Sets the categories to open in the TreeCat
        Parameters:
        ocids - an array of Categories' id
      • setExText

        public void setExText​(java.lang.String text)
        Sets the text to search
        Parameters:
        text - whatever text to search
      • setExTypes

        public void setExTypes​(java.lang.String[] types)
        Sets the type refinement to be use in the Explorer
        Parameters:
        types - an array of String, each string being a classname, eg. {"Content", "generated.Article"}
      • setExDocumentKinds

        public void setExDocumentKinds​(java.lang.String[] documentKinds)
        Sets the document kind refinement to use in the Explorer
        Parameters:
        documentKinds - an array of String, each string being a document kind as defined in JCMS
        Since:
        explorer-2.1
      • setExPstatus

        public void setExPstatus​(java.lang.String[] pstatus)
        Sets the pstatus to use for refinement in the Explorer
        Parameters:
        pstatus - an array of String, each string being a pstatus, eg. {"-10", "20"}
      • setExShowInvisiblePubs

        public void setExShowInvisiblePubs​(boolean showInvisiblePubs)
        Sets whether to display invisible publication or not
        Parameters:
        showInvisiblePubs - true to display invisible publication, false otherwise
      • setExSearchInFiles

        public void setExSearchInFiles​(boolean searchInFiles)
        Sets whether to perform search in files or not
        Parameters:
        searchInFiles - true to search in content of files, false otherwise
      • setExPreviewId

        public void setExPreviewId​(java.lang.String previewId)
        Sets the id of the Publication to preview in the explorer
        Parameters:
        previewId - a Publication id
      • setExFields

        public void setExFields​(java.lang.String[] fields)
        Sets the fields that should be displayed in explorer view.
        Parameters:
        fields - an array of field name e.g. { "id", "title", "mdate" }
      • setExShowSidebar

        public void setExShowSidebar​(boolean showSidebar)
        Sets whether sidebar is visible or not
        Parameters:
        showSidebar - true to display sidebar, false to hide it
        Since:
        explorer-2.0.1
      • setExSearchOptionsState

        public void setExSearchOptionsState​(java.lang.String searchOptionsState)
        Sets whether search options pane should be displayed, collapsed, or hidden.
        Parameters:
        searchOptionsState - "show", "collapse" or "hide"
      • setExNavigationState

        public void setExNavigationState​(java.lang.String navigationState)
        Sets whether navigation pane should be displayed, collapsed, or hidden.
        Parameters:
        navigationState - "show", "collapse" or "hide"
      • setExFieldsState

        public void setExFieldsState​(java.lang.String fieldsState)
        Sets whether fields pane should be displayed, collapsed, or hidden.
        Parameters:
        fieldsState - "show", "collapse" or "hide"
      • setExsort

        public void setExsort​(java.lang.String sort)
      • setExreverse

        public void setExreverse​(boolean v)
      • setExstart

        public void setExstart​(int start)
      • setExpageSize

        public void setExpageSize​(int pageSize)
      • setExpagerAll

        public void setExpagerAll​(boolean pagerAll)