Package org.joinfaces.autoconfigure.adminfaces

Class 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:
    Serialized Form

    • Constructor Detail

      • AdminfacesProperties

        public AdminfacesProperties()

    • Method Detail

      • getLoginPage

        public String getLoginPage()
        login page location (relative to webapp). It you only be used if you configure Admin Session.

      • getIndexPage

        public String getIndexPage()
        index page location. User will be redirected to it when it access app root (contextPath/).

      • getDateFormat

        public String getDateFormat()
        Date format used in error page (500.xhtml), by default it is JVM default format.

      • getTemplatePath

        public String getTemplatePath()
        Template path.

      • getBreadcrumbSize

        public Integer getBreadcrumbSize()
        Number of breadcrumbs to queue before removing the older ones.

      • getRenderMessages

        public Boolean getRenderMessages()
        When false, p:messages defined in admin template will not be rendered.

      • getRenderAjaxStatus

        public Boolean getRenderAjaxStatus()
        When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered.

      • getDisableFilter

        public Boolean 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

        public Boolean getRenderBreadCrumb()
        When false, the breadCrumb component, declared in admin template, will not be rendered.

      • getEnableSlideMenu

        public Boolean 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

        public Boolean getEnableRipple()
        When true it will create a wave/ripple effect on elements specified by rippleElements.

      • getRippleElements

        public String getRippleElements()
        A list of comma separated list of (jquery) selector which elements will be affected by ripple effect.

      • getSkin

        public String getSkin()
        Default template skin.

      • getAutoShowNavbar

        public Boolean getAutoShowNavbar()
        Automatic shows navbar when users scrolls page up (on small screens). Can be enable/disabled per page with <ui:param name="autoShowNavbar" value="false" />.

      • getIgnoredResources

        public String 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

        public String getLoadingImage()
        image used for the loading popup. It must be under webapp/resources/images folder.

      • getExtensionLessUrls

        public Boolean getExtensionLessUrls()
        Removes extension suffix from breadCrumb links.

      • getRenderControlSidebar

        public Boolean getRenderControlSidebar()
        When true it will activate control sidebar component.

      • getRippleMobileOnly

        public Boolean getRippleMobileOnly()
        When true the ripple effect will be enabled only on mobile (small) screens.

      • getRenderMenuSearch

        public Boolean getRenderMenuSearch()
        Enables or disables menu search.

      • getAutoHideMessages

        public Boolean getAutoHideMessages()
        If true PrimeFaces info messages will be hidden after a certain timeout.

      • getMessagesHideTimeout

        public String getMessagesHideTimeout()
        Timeout to hide info messages. Note that the timeout is also composed by configured timeout + number of words in message.

      • getIconsEffect

        public Boolean getIconsEffect()
        Enables material effect when icons (e.g modal close, calendar) are clicked.

      • getRenderFormAsterisks

        public Boolean getRenderFormAsterisks()
        When true, the asterisk on required form elements is rendered.

      • getClosableLoading

        public Boolean getClosableLoading()
        When true, closeable loading is enabled.

      • getEnableMobileHeader

        public Boolean getEnableMobileHeader()
        When true, the mobile header is enabled.

      • setLoginPage

        public void setLoginPage​(String loginPage)
        login page location (relative to webapp). It you only be used if you configure Admin Session.

      • setIndexPage

        public void setIndexPage​(String indexPage)
        index page location. User will be redirected to it when it access app root (contextPath/).

      • setDateFormat

        public void setDateFormat​(String dateFormat)
        Date format used in error page (500.xhtml), by default it is JVM default format.

      • setTemplatePath

        public void setTemplatePath​(String templatePath)
        Template path.

      • setBreadcrumbSize

        public void setBreadcrumbSize​(Integer breadcrumbSize)
        Number of breadcrumbs to queue before removing the older ones.

      • setRenderMessages

        public void setRenderMessages​(Boolean renderMessages)
        When false, p:messages defined in admin template will not be rendered.

      • setRenderAjaxStatus

        public void setRenderAjaxStatus​(Boolean renderAjaxStatus)
        When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered.

      • setDisableFilter

        public 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.

      • setRenderBreadCrumb

        public void setRenderBreadCrumb​(Boolean renderBreadCrumb)
        When false, the breadCrumb component, declared in admin template, will not be rendered.

      • setEnableSlideMenu

        public void setEnableSlideMenu​(Boolean enableSlideMenu)
        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

        public void setEnableRipple​(Boolean enableRipple)
        When true it will create a wave/ripple effect on elements specified by rippleElements.

      • setRippleElements

        public void setRippleElements​(String rippleElements)
        A list of comma separated list of (jquery) selector which elements will be affected by ripple effect.

      • setSkin

        public void setSkin​(String skin)
        Default template skin.

      • setAutoShowNavbar

        public void setAutoShowNavbar​(Boolean autoShowNavbar)
        Automatic shows navbar when users scrolls page up (on small screens). Can be enable/disabled per page with <ui:param name="autoShowNavbar" value="false" />.

      • setIgnoredResources

        public void setIgnoredResources​(String ignoredResources)
        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

        public void setLoadingImage​(String loadingImage)
        image used for the loading popup. It must be under webapp/resources/images folder.

      • setExtensionLessUrls

        public void setExtensionLessUrls​(Boolean extensionLessUrls)
        Removes extension suffix from breadCrumb links.

      • setRenderControlSidebar

        public void setRenderControlSidebar​(Boolean renderControlSidebar)
        When true it will activate control sidebar component.

      • setRippleMobileOnly

        public void setRippleMobileOnly​(Boolean rippleMobileOnly)
        When true the ripple effect will be enabled only on mobile (small) screens.

      • setRenderMenuSearch

        public void setRenderMenuSearch​(Boolean renderMenuSearch)
        Enables or disables menu search.

      • setAutoHideMessages

        public void setAutoHideMessages​(Boolean autoHideMessages)
        If true PrimeFaces info messages will be hidden after a certain timeout.

      • setMessagesHideTimeout

        public void setMessagesHideTimeout​(String messagesHideTimeout)
        Timeout to hide info messages. Note that the timeout is also composed by configured timeout + number of words in message.

      • setIconsEffect

        public void setIconsEffect​(Boolean iconsEffect)
        Enables material effect when icons (e.g modal close, calendar) are clicked.

      • setRenderFormAsterisks

        public void setRenderFormAsterisks​(Boolean renderFormAsterisks)
        When true, the asterisk on required form elements is rendered.

      • setClosableLoading

        public void setClosableLoading​(Boolean closableLoading)
        When true, closeable loading is enabled.

      • setEnableMobileHeader

        public void setEnableMobileHeader​(Boolean enableMobileHeader)
        When true, the mobile header is enabled.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object