Class AdminfacesProperties
java.lang.Object
org.joinfaces.autoconfigure.adminfaces.AdminfacesProperties
- All Implemented Interfaces:
Serializable
@ConfigurationProperties(prefix="joinfaces.adminfaces")
public class AdminfacesProperties
extends Object
implements Serializable
Configuration properties of AdminFaces.
Taken from
- https://github.com/adminfaces/admin-template#configuration
- https://github.com/adminfaces/admin-template/blob/master/src/main/java/com/github/adminfaces/template/config/AdminConfig.java
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
ControlSidebar properties. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
If true PrimeFaces info messages will be hidden after a certain timeout.Automatic shows navbar when users scrolls page up (on small screens).Number of breadcrumbs to queue before removing the older ones.When true, closeable loading is enabled.When true it will activate control sidebar component.Date format used in error page (500.xhtml), by default it is JVM default format.Disables AdminFilter, responsible for redirecting user after session timeout, sending user to logon page when it is not logged in among other things.When true, the mobile header is enabled.When true it will create a wave/ripple effect on elements specified by rippleElements.If true will make left menu touch enable (can be closed or opened via touch).Removes extension suffix from breadCrumb links.Enables material effect when icons (e.g modal close, calendar) are clicked.Comma separated resources (pages or urls) to be skiped by AdminFilter.index page location.image used for the loading popup.login page location (relative to webapp).Timeout to hide info messages.When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered.When false, the breadCrumb component, declared in admin template, will not be rendered.When true it will activate control sidebar component.When true, the asterisk on required form elements is rendered.Enables or disables menu search.When false, p:messages defined in admin template will not be rendered.A list of comma separated list of (jquery) selector which elements will be affected by ripple effect.When true the ripple effect will be enabled only on mobile (small) screens.getSkin()
Default template skin.When true, p:message will not show details if equals to summary.Template path.int
hashCode()
void
setAutoHideMessages
(Boolean autoHideMessages) If true PrimeFaces info messages will be hidden after a certain timeout.void
setAutoShowNavbar
(Boolean autoShowNavbar) Automatic shows navbar when users scrolls page up (on small screens).void
setBreadcrumbSize
(Integer breadcrumbSize) Number of breadcrumbs to queue before removing the older ones.void
setClosableLoading
(Boolean closableLoading) When true, closeable loading is enabled.void
setDateFormat
(String dateFormat) Date format used in error page (500.xhtml), by default it is JVM default format.void
setDisableFilter
(Boolean disableFilter) Disables AdminFilter, responsible for redirecting user after session timeout, sending user to logon page when it is not logged in among other things.void
setEnableMobileHeader
(Boolean enableMobileHeader) When true, the mobile header is enabled.void
setEnableRipple
(Boolean enableRipple) When true it will create a wave/ripple effect on elements specified by rippleElements.void
setEnableSlideMenu
(Boolean enableSlideMenu) If true will make left menu touch enable (can be closed or opened via touch).void
setExtensionLessUrls
(Boolean extensionLessUrls) Removes extension suffix from breadCrumb links.void
setIconsEffect
(Boolean iconsEffect) Enables material effect when icons (e.g modal close, calendar) are clicked.void
setIgnoredResources
(String ignoredResources) Comma separated resources (pages or urls) to be skiped by AdminFilter.void
setIndexPage
(String indexPage) index page location.void
setLoadingImage
(String loadingImage) image used for the loading popup.void
setLoginPage
(String loginPage) login page location (relative to webapp).void
setMessagesHideTimeout
(String messagesHideTimeout) Timeout to hide info messages.void
setRenderAjaxStatus
(Boolean renderAjaxStatus) When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered.void
setRenderBreadCrumb
(Boolean renderBreadCrumb) When false, the breadCrumb component, declared in admin template, will not be rendered.void
setRenderControlSidebar
(Boolean renderControlSidebar) When true it will activate control sidebar component.void
setRenderFormAsterisks
(Boolean renderFormAsterisks) When true, the asterisk on required form elements is rendered.void
setRenderMenuSearch
(Boolean renderMenuSearch) Enables or disables menu search.void
setRenderMessages
(Boolean renderMessages) When false, p:messages defined in admin template will not be rendered.void
setRippleElements
(String rippleElements) A list of comma separated list of (jquery) selector which elements will be affected by ripple effect.void
setRippleMobileOnly
(Boolean rippleMobileOnly) When true the ripple effect will be enabled only on mobile (small) screens.void
Default template skin.void
setSkipMessageDetailIfEqualsSummary
(Boolean skipMessageDetailIfEqualsSummary) When true, p:message will not show details if equals to summary.void
setTemplatePath
(String templatePath) Template path.toString()
-
Constructor Details
-
AdminfacesProperties
public AdminfacesProperties()
-
-
Method Details
-
getLoginPage
login page location (relative to webapp). It you only be used if you configure Admin Session. -
getIndexPage
index page location. User will be redirected to it when it access app root (contextPath/). -
getDateFormat
Date format used in error page (500.xhtml), by default it is JVM default format. -
getTemplatePath
Template path. -
getBreadcrumbSize
Number of breadcrumbs to queue before removing the older ones. -
getRenderMessages
When false, p:messages defined in admin template will not be rendered. -
getSkipMessageDetailIfEqualsSummary
When true, p:message will not show details if equals to summary. -
getRenderAjaxStatus
When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered. -
getDisableFilter
Disables AdminFilter, responsible for redirecting user after session timeout, sending user to logon page when it is not logged in among other things. -
getRenderBreadCrumb
When false, the breadCrumb component, declared in admin template, will not be rendered. -
getEnableSlideMenu
If true will make left menu touch enable (can be closed or opened via touch). Can be enable/disabled per page with<ui:param name="enableSlideMenu" value="false" />
. -
getEnableRipple
When true it will create a wave/ripple effect on elements specified by rippleElements. -
getRippleElements
A list of comma separated list of (jquery) selector which elements will be affected by ripple effect. -
getSkin
Default template skin. -
getIgnoredResources
Comma separated resources (pages or urls) to be skiped by AdminFilter. Ex: /rest, /pages/car-list. Note that by default the filter skips pages under CONTEXT/public/ folder. -
getLoadingImage
image used for the loading popup. It must be under webapp/resources/images folder. -
getExtensionLessUrls
Removes extension suffix from breadCrumb links. -
getRenderControlSidebar
When true it will activate control sidebar component. -
getRippleMobileOnly
When true the ripple effect will be enabled only on mobile (small) screens. -
getRenderMenuSearch
Enables or disables menu search. -
getAutoHideMessages
If true PrimeFaces info messages will be hidden after a certain timeout. -
getMessagesHideTimeout
Timeout to hide info messages. Note that the timeout is also composed by configured timeout + number of words in message. -
getIconsEffect
Enables material effect when icons (e.g modal close, calendar) are clicked. -
getControlSidebar
When true it will activate control sidebar component. -
getRenderFormAsterisks
When true, the asterisk on required form elements is rendered. -
getClosableLoading
When true, closeable loading is enabled. -
getEnableMobileHeader
When true, the mobile header is enabled. -
setLoginPage
login page location (relative to webapp). It you only be used if you configure Admin Session. -
setIndexPage
index page location. User will be redirected to it when it access app root (contextPath/). -
setDateFormat
Date format used in error page (500.xhtml), by default it is JVM default format. -
setTemplatePath
Template path. -
setBreadcrumbSize
Number of breadcrumbs to queue before removing the older ones. -
setRenderMessages
When false, p:messages defined in admin template will not be rendered. -
setSkipMessageDetailIfEqualsSummary
When true, p:message will not show details if equals to summary. -
setRenderAjaxStatus
When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered. -
setDisableFilter
Disables AdminFilter, responsible for redirecting user after session timeout, sending user to logon page when it is not logged in among other things. -
setRenderBreadCrumb
When false, the breadCrumb component, declared in admin template, will not be rendered. -
setEnableSlideMenu
If true will make left menu touch enable (can be closed or opened via touch). Can be enable/disabled per page with<ui:param name="enableSlideMenu" value="false" />
. -
setEnableRipple
When true it will create a wave/ripple effect on elements specified by rippleElements. -
setRippleElements
A list of comma separated list of (jquery) selector which elements will be affected by ripple effect. -
setSkin
Default template skin. -
setIgnoredResources
Comma separated resources (pages or urls) to be skiped by AdminFilter. Ex: /rest, /pages/car-list. Note that by default the filter skips pages under CONTEXT/public/ folder. -
setLoadingImage
image used for the loading popup. It must be under webapp/resources/images folder. -
setExtensionLessUrls
Removes extension suffix from breadCrumb links. -
setRenderControlSidebar
When true it will activate control sidebar component. -
setRippleMobileOnly
When true the ripple effect will be enabled only on mobile (small) screens. -
setRenderMenuSearch
Enables or disables menu search. -
setAutoHideMessages
If true PrimeFaces info messages will be hidden after a certain timeout. -
setMessagesHideTimeout
Timeout to hide info messages. Note that the timeout is also composed by configured timeout + number of words in message. -
setIconsEffect
Enables material effect when icons (e.g modal close, calendar) are clicked. -
setRenderFormAsterisks
When true, the asterisk on required form elements is rendered. -
setClosableLoading
When true, closeable loading is enabled. -
setEnableMobileHeader
When true, the mobile header is enabled. -
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-