Package com.jalios.jcms.uicomponent.topbar

Class TopbarHandler

java.lang.Object

com.jalios.jcms.context.JcmsContext

com.jalios.jcms.context.JcmsJspContext

com.jalios.jcms.handler.JcmsFormHandler

com.jalios.jcms.uicomponent.topbar.TopbarHandler

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class TopbarHandler
extends JcmsFormHandler

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TopbarHandler.ApplicationSelector	Select a subset of ShortCut which must be displayed in tools page
static class	TopbarHandler.Zone

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	HIDE_NAVIGATION_REQUEST_ATTR
static java.lang.String	JCMS_TOPBAR_DISPLAY_REQUEST_ATTR
static java.lang.String	REVISION
static java.lang.String	WRAP_LOGO_WITH_H1_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, 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
TopbarHandler()

Method Summary

Modifier and Type	Method	Description
void	addFrontEndDependencies()
boolean	displayTopbar()
int	getCaddyCount()
PortalInterface	getCurrentPortal()
java.util.Set<TopbarApplicationItem>	getFavoriteMemberApps()
java.util.Set<TopbarApplicationItem>	getGlobalMemberApps()
java.lang.String	getLogoStyle()
java.lang.String	getPortletSearchMobileUrl()
DataAttribute	getSearchDataAttributes()
java.lang.String	getTargetPrefix()
java.lang.String	getTopbarCss()
java.lang.String	getTopbarHomeTitle()
java.lang.String	getTopbarHomeUrl()
java.util.Set<TopbarItem>	getTopbarItemSet()
PortalElement	getTopbarPortlet()
static java.lang.String	getTopbarResource(TopbarHandler.Zone zone)
java.lang.String	getTopbarWrapperCss()
boolean	isAdminZone()
boolean	isAppPortal()
boolean	isFrontZone()
boolean	isFullWidth()
boolean	isNavigationExpanded()
boolean	isWorkZone()
boolean	showAdminMenuEntry()
boolean	showApplicationMenu()
boolean	showCaddyMenuEntry()
boolean	showInspectDataMenuEntry()
boolean	showLoginMenu()
boolean	showMemberMenu()
boolean	showNavigationMenu()
boolean	showPortalMenuEntry()
boolean	showPublishMenuEntry()
boolean	showToolsMenu()
boolean	showWorkMenuEntry()
boolean	showWorkspaceMenu()
boolean	wrapLogoWithH1()

Methods inherited from class com.jalios.jcms.handler.JcmsFormHandler

afterValidation, checkMissingField, getAvailableMainLanguage, 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, processAction, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, showFinishButton, showNextButton, showPreviousButton, 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, 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, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWebdavAccess, removeMessage, removeMessage, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HIDE_NAVIGATION_REQUEST_ATTR

public static final java.lang.String HIDE_NAVIGATION_REQUEST_ATTR

See Also:

Constant Field Values

JCMS_TOPBAR_DISPLAY_REQUEST_ATTR

public static final java.lang.String JCMS_TOPBAR_DISPLAY_REQUEST_ATTR

See Also:

Constant Field Values

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

WRAP_LOGO_WITH_H1_REQUEST_ATTR

public static final java.lang.String WRAP_LOGO_WITH_H1_REQUEST_ATTR

See Also:

Constant Field Values

Constructor Detail

TopbarHandler

public TopbarHandler()

Method Detail

addFrontEndDependencies

public void addFrontEndDependencies()

getSearchDataAttributes

public DataAttribute getSearchDataAttributes()

getTopbarResource

public static java.lang.String getTopbarResource(TopbarHandler.Zone zone)

isAdminZone

public boolean isAdminZone()

Overrides:

isAdminZone in class JcmsContext

Returns:

true if "zone" request attribute is equal to "AdminArea".

isWorkZone

public boolean isWorkZone()

Overrides:

isWorkZone in class JcmsContext

Returns:

true if "zone" request attribute is equal to "WorkArea".

isFrontZone

public boolean isFrontZone()

isFullWidth

public boolean isFullWidth()

getTopbarWrapperCss

public java.lang.String getTopbarWrapperCss()

getTopbarCss

public java.lang.String getTopbarCss()

getTopbarItemSet

public java.util.Set<TopbarItem> getTopbarItemSet()

displayTopbar

public boolean displayTopbar()

getFavoriteMemberApps

public java.util.Set<TopbarApplicationItem> getFavoriteMemberApps()

getGlobalMemberApps

public java.util.Set<TopbarApplicationItem> getGlobalMemberApps()

getTopbarHomeUrl

public java.lang.String getTopbarHomeUrl()

getTopbarHomeTitle

public java.lang.String getTopbarHomeTitle()

isAppPortal

public boolean isAppPortal()

getCurrentPortal

public PortalInterface getCurrentPortal()

showPortalMenuEntry

public boolean showPortalMenuEntry()

showToolsMenu

public boolean showToolsMenu()

showAdminMenuEntry

public boolean showAdminMenuEntry()

showCaddyMenuEntry

public boolean showCaddyMenuEntry()

showPublishMenuEntry

public boolean showPublishMenuEntry()

getCaddyCount

public int getCaddyCount()

showWorkMenuEntry

public boolean showWorkMenuEntry()

showInspectDataMenuEntry

public boolean showInspectDataMenuEntry()

showApplicationMenu

public boolean showApplicationMenu()

showMemberMenu

public boolean showMemberMenu()

showLoginMenu

public boolean showLoginMenu()

showWorkspaceMenu

public boolean showWorkspaceMenu()

showNavigationMenu

public boolean showNavigationMenu()

isNavigationExpanded

public boolean isNavigationExpanded()

getTargetPrefix

public java.lang.String getTargetPrefix()

getTopbarPortlet

public PortalElement getTopbarPortlet()

getPortletSearchMobileUrl

public java.lang.String getPortletSearchMobileUrl()

getLogoStyle

public java.lang.String getLogoStyle()

wrapLogoWithH1

public boolean wrapLogoWithH1()