Package com.jalios.jcms.jportal
Class JPortalEditorHandler
- java.lang.Object
-
- com.jalios.jcms.context.JcmsContext
-
- com.jalios.jcms.context.JcmsJspContext
-
- com.jalios.jcms.handler.JcmsFormHandler
-
- com.jalios.jcms.jportal.JPortalEditorHandler
-
- All Implemented Interfaces:
JcmsConstants,JaliosConstants
public class JPortalEditorHandler extends JcmsFormHandler
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String[]containerCssClassstatic java.lang.String[]containerLabelsstatic java.lang.StringFORM_HANDLER_REQUEST_ATTRstatic java.lang.StringJPORTAL_EDITION_REQUEST_ATTRstatic java.lang.StringJPORTAL_INSTANCE_REQUEST_ATTRstatic java.lang.StringPORTLET_EDITION_REQUEST_ATTR-
Fields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForced
-
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, 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_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_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_DIR, 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 JPortalEditorHandler()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddFrontEndDependencies()booleancanCreatePortlet()PortletCollectiongetAvailableCollaborativeSpace()AbstractJPortalgetAvailableJPortal()JPortalMappinggetAvailableJPortalMapping()WorkspacegetAvailableWorkspaceFilter()java.lang.StringgetBlockId()java.lang.StringgetBlocksAndSize()java.lang.StringgetBlockToMoveId()java.lang.StringgetCloseUrl()TextFieldSettingsgetComponentsAutoCompleteSettings()java.lang.StringgetComponentSearchName()java.lang.String[]getContainerCssClass()java.lang.String[]getContainerLabels(java.lang.String lang)EnumerateSettingsgetEnumerateSettings(java.lang.String prop)java.lang.StringgetJPortalMappingUI()java.lang.StringgetjPortalStructure()java.lang.StringgetMovePosition()java.lang.StringgetNewBlockId()java.lang.StringgetOpUnlock()java.lang.Class<Portlet>getPortletClass()java.lang.StringgetPortletEditTemplatePath()java.lang.StringgetPortletId()java.util.Set<Portlet>getPortletInstanceSet()java.lang.StringgetPortletName()java.util.Set<PortalInterface>getPortletPortalSet()java.util.Set<Portlet>getPortletSet()static java.lang.StringgetPortletSimpleName(java.lang.String portletName)static java.util.Set<TypeTemplateEntry>getPortletTypeTemplateEntrySet(java.lang.Class portletClazz)java.lang.StringgetPublishModalUrl()java.lang.StringgetResult()static java.util.Set<TypeTemplateEntry>getSkinTemplateEntrySet(AbstractJPortal jPortal)java.lang.StringgetSkinUsage()java.lang.StringgetTargetBlockId()java.lang.StringgetText()EnumerateSettingsgetWorkspaceFilterSettings()booleanisCreatePortlet()booleanisJPortalCollaborativeSpace()Check if the edited jportal belongs to a CollaborativeSpacebooleanisOpMoveBlockAndUpdateSizes()booleanisOpRemoveBlockAndUpdateSizes()booleanisOpResetHistory()booleanisOpSaveStructure()booleanisPortletJaliosSkin()booleanisSearchPerformed()booleanprocessAction()Method to be implemented to check/validate action to be performed and process them.voidsetBlockId(java.lang.String blockId)voidsetBlocksAndSize(java.lang.String blocksAndSize)voidsetBlockToMoveId(java.lang.String blockToMoveId)voidsetCollaborativeSpace(java.lang.String collaborativeSpace)voidsetComponentSearchName(java.lang.String componentSearchName)voidsetCreatePortlet(boolean createPortlet)voidsetjPortal(java.lang.String jPortalId)voidsetjPortalStructure(java.lang.String jPortalStructure)voidsetMovePosition(java.lang.String movePosition)voidsetNewBlockId(java.lang.String newBlockId)voidsetOpMoveBlockAndUpdateSizes(boolean opMoveBlockAndUpdateSizes)voidsetOpRemoveBlockAndUpdateSizes(boolean opRemoveBlockAndUpdateSizes)voidsetOpResetHistory(boolean opResetHistory)voidsetOpSaveStructure(boolean opSaveStructure)voidsetOpUnlock(java.lang.String opUnlock)voidsetPortletClass(java.lang.Class<Portlet> portletClass)voidsetPortletClassName(java.lang.String portletClassName)voidsetPortletId(java.lang.String portletId)voidsetResult(java.lang.String result)voidsetTargetBlockId(java.lang.String targetBlockId)voidsetText(java.lang.String text)voidsetWorkspaceFilter(java.lang.String workspaceFilter)-
Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler
afterValidation, canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getControllerContext, getEditFieldSet, getFormStep, getFormStepCount, getFormStepFinishLabel, getFormStepHiddenFields, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getModalRedirect, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getRedirect, getRedirectOnClosePopup, getWorkspace, init, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performFinish, performNext, performPrevious, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, startProcess, updateUploadedField, updateUploadedFields, updateUploadedFields, validate, validateCSRF, validateFinish, validateNext, validatePrevious
-
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, copyMsgListToMsgSessionList, 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, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, isWorkZone, removeMessage, removeMessage, removeMsg, retrieveUploadedFile, select, sendError, sendError, sendForbidden, sendForbidden, 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
-
-
-
-
Field Detail
-
PORTLET_EDITION_REQUEST_ATTR
public static final java.lang.String PORTLET_EDITION_REQUEST_ATTR
- See Also:
- Constant Field Values
-
FORM_HANDLER_REQUEST_ATTR
public static final java.lang.String FORM_HANDLER_REQUEST_ATTR
- See Also:
- Constant Field Values
-
JPORTAL_INSTANCE_REQUEST_ATTR
public static final java.lang.String JPORTAL_INSTANCE_REQUEST_ATTR
- See Also:
- Constant Field Values
-
JPORTAL_EDITION_REQUEST_ATTR
public static final java.lang.String JPORTAL_EDITION_REQUEST_ATTR
- See Also:
- Constant Field Values
-
containerCssClass
public static final java.lang.String[] containerCssClass
-
containerLabels
public static final java.lang.String[] containerLabels
-
-
Method Detail
-
getCloseUrl
public java.lang.String getCloseUrl()
-
getPublishModalUrl
public java.lang.String getPublishModalUrl()
-
processAction
public boolean processAction() throws java.io.IOExceptionDescription copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classJcmsFormHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
java.io.IOException- IO Exception
-
getPortletSet
public java.util.Set<Portlet> getPortletSet()
-
canCreatePortlet
public boolean canCreatePortlet()
-
getPortletName
public java.lang.String getPortletName()
-
getPortletEditTemplatePath
public java.lang.String getPortletEditTemplatePath()
-
getPortletTypeTemplateEntrySet
public static java.util.Set<TypeTemplateEntry> getPortletTypeTemplateEntrySet(java.lang.Class portletClazz)
-
getSkinTemplateEntrySet
public static java.util.Set<TypeTemplateEntry> getSkinTemplateEntrySet(AbstractJPortal jPortal)
-
isSearchPerformed
public boolean isSearchPerformed()
-
isJPortalCollaborativeSpace
public boolean isJPortalCollaborativeSpace()
Check if the edited jportal belongs to a CollaborativeSpace- Returns:
- true if the edited jportal belongs to a collaborative space
- Since:
- jcms-10.0.7
-
getSkinUsage
public java.lang.String getSkinUsage()
-
getPortletInstanceSet
public java.util.Set<Portlet> getPortletInstanceSet()
-
isPortletJaliosSkin
public boolean isPortletJaliosSkin()
- Returns:
- true if current portlet uses jalios skin
-
getPortletPortalSet
public java.util.Set<PortalInterface> getPortletPortalSet()
-
getEnumerateSettings
public EnumerateSettings getEnumerateSettings(java.lang.String prop)
-
getComponentsAutoCompleteSettings
public TextFieldSettings getComponentsAutoCompleteSettings()
-
getWorkspaceFilterSettings
public EnumerateSettings getWorkspaceFilterSettings()
-
addFrontEndDependencies
public void addFrontEndDependencies()
-
getAvailableJPortal
public AbstractJPortal getAvailableJPortal()
-
getjPortalStructure
public java.lang.String getjPortalStructure()
-
setjPortalStructure
public void setjPortalStructure(java.lang.String jPortalStructure)
-
getPortletClass
public java.lang.Class<Portlet> getPortletClass()
-
setPortletClassName
public void setPortletClassName(java.lang.String portletClassName)
-
isCreatePortlet
public boolean isCreatePortlet()
-
setCreatePortlet
public void setCreatePortlet(boolean createPortlet)
-
getPortletId
public java.lang.String getPortletId()
-
setPortletId
public void setPortletId(java.lang.String portletId)
-
getBlockId
public java.lang.String getBlockId()
-
setBlockId
public void setBlockId(java.lang.String blockId)
-
setjPortal
public void setjPortal(java.lang.String jPortalId)
-
getText
public java.lang.String getText()
-
setText
public void setText(java.lang.String text)
-
getAvailableJPortalMapping
public JPortalMapping getAvailableJPortalMapping()
-
getJPortalMappingUI
public java.lang.String getJPortalMappingUI()
-
getOpUnlock
public java.lang.String getOpUnlock()
-
setOpUnlock
public void setOpUnlock(java.lang.String opUnlock)
-
getPortletSimpleName
public static java.lang.String getPortletSimpleName(java.lang.String portletName)
-
isOpResetHistory
public boolean isOpResetHistory()
-
setOpResetHistory
public void setOpResetHistory(boolean opResetHistory)
-
getContainerCssClass
public java.lang.String[] getContainerCssClass()
-
getContainerLabels
public java.lang.String[] getContainerLabels(java.lang.String lang)
-
getComponentSearchName
public java.lang.String getComponentSearchName()
-
setComponentSearchName
public void setComponentSearchName(java.lang.String componentSearchName)
-
isOpSaveStructure
public boolean isOpSaveStructure()
-
setOpSaveStructure
public void setOpSaveStructure(boolean opSaveStructure)
-
getResult
public java.lang.String getResult()
-
setResult
public void setResult(java.lang.String result)
-
isOpRemoveBlockAndUpdateSizes
public boolean isOpRemoveBlockAndUpdateSizes()
-
setOpRemoveBlockAndUpdateSizes
public void setOpRemoveBlockAndUpdateSizes(boolean opRemoveBlockAndUpdateSizes)
-
setPortletClass
public void setPortletClass(java.lang.Class<Portlet> portletClass)
-
getAvailableCollaborativeSpace
public PortletCollection getAvailableCollaborativeSpace()
-
setCollaborativeSpace
public void setCollaborativeSpace(java.lang.String collaborativeSpace)
-
getBlocksAndSize
public java.lang.String getBlocksAndSize()
-
setBlocksAndSize
public void setBlocksAndSize(java.lang.String blocksAndSize)
-
getTargetBlockId
public java.lang.String getTargetBlockId()
-
setTargetBlockId
public void setTargetBlockId(java.lang.String targetBlockId)
-
getMovePosition
public java.lang.String getMovePosition()
-
setMovePosition
public void setMovePosition(java.lang.String movePosition)
-
isOpMoveBlockAndUpdateSizes
public boolean isOpMoveBlockAndUpdateSizes()
-
setOpMoveBlockAndUpdateSizes
public void setOpMoveBlockAndUpdateSizes(boolean opMoveBlockAndUpdateSizes)
-
getNewBlockId
public java.lang.String getNewBlockId()
-
setNewBlockId
public void setNewBlockId(java.lang.String newBlockId)
-
getBlockToMoveId
public java.lang.String getBlockToMoveId()
-
setBlockToMoveId
public void setBlockToMoveId(java.lang.String blockToMoveId)
-
getAvailableWorkspaceFilter
public Workspace getAvailableWorkspaceFilter()
-
setWorkspaceFilter
public void setWorkspaceFilter(java.lang.String workspaceFilter)
-
-