Package org.joinfaces.autoconfigure.adminfaces

Class AdminfacesProperties

  • All Implemented Interfaces:
    java.io.Serializable
    @ConfigurationProperties(prefix="joinfaces.adminfaces")
public class AdminfacesProperties
extends java.lang.Object
implements java.io.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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected boolean canEqual​(java.lang.Object other)  
      boolean equals​(java.lang.Object o)  
      java.lang.Boolean getAutoHideMessages()
      If true PrimeFaces info messages will be hidden after a certain timeout.
      java.lang.Boolean getAutoShowNavbar()
      Automatic shows navbar when users scrolls page up (on small screens).
      java.lang.Integer getBreadcrumbSize()
      Number of breadcrumbs to queue before removing the older ones.
      java.lang.Boolean getClosableLoading()
      When true, closeable loading is enabled.
      AdminfacesProperties.ControlSidebar getControlSidebar()
      When true it will activate control sidebar component.
      java.lang.String getDateFormat()
      Date format used in error page (500.xhtml), by default it is JVM default format.
      java.lang.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.
      java.lang.Boolean getEnableMobileHeader()
      When true, the mobile header is enabled.
      java.lang.Boolean getEnableRipple()
      When true it will create a wave/ripple effect on elements specified by rippleElements.
      java.lang.Boolean getEnableSlideMenu()
      If true will make left menu touch enable (can be closed or opened via touch).
      java.lang.Boolean getExtensionLessUrls()
      Removes extension suffix from breadCrumb links.
      java.lang.Boolean getIconsEffect()
      Enables material effect when icons (e.g modal close, calendar) are clicked.
      java.lang.String getIgnoredResources()
      Comma separated resources (pages or urls) to be skiped by AdminFilter.
      java.lang.String getIndexPage()
      index page location.
      java.lang.String getLoadingImage()
      image used for the loading popup.
      java.lang.String getLoginPage()
      login page location (relative to webapp).
      java.lang.String getMessagesHideTimeout()
      Timeout to hide info messages.
      java.lang.Boolean getRenderAjaxStatus()
      When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered.
      java.lang.Boolean getRenderBreadCrumb()
      When false, the breadCrumb component, declared in admin template, will not be rendered.
      java.lang.Boolean getRenderControlSidebar()
      When true it will activate control sidebar component.
      java.lang.Boolean getRenderFormAsterisks()
      When true, the asterisk on required form elements is rendered.
      java.lang.Boolean getRenderMenuSearch()
      Enables or disables menu search.
      java.lang.Boolean getRenderMessages()
      When false, p:messages defined in admin template will not be rendered.
      java.lang.String getRippleElements()
      A list of comma separated list of (jquery) selector which elements will be affected by ripple effect.
      java.lang.Boolean getRippleMobileOnly()
      When true the ripple effect will be enabled only on mobile (small) screens.
      java.lang.String getSkin()
      Default template skin.
      java.lang.Boolean getSkipMessageDetailIfEqualsSummary()
      When true, p:message will not show details if equals to summary.
      java.lang.String getTemplatePath()
      Template path.
      int hashCode()  
      void setAutoHideMessages​(java.lang.Boolean autoHideMessages)
      If true PrimeFaces info messages will be hidden after a certain timeout.
      void setAutoShowNavbar​(java.lang.Boolean autoShowNavbar)
      Automatic shows navbar when users scrolls page up (on small screens).
      void setBreadcrumbSize​(java.lang.Integer breadcrumbSize)
      Number of breadcrumbs to queue before removing the older ones.
      void setClosableLoading​(java.lang.Boolean closableLoading)
      When true, closeable loading is enabled.
      void setDateFormat​(java.lang.String dateFormat)
      Date format used in error page (500.xhtml), by default it is JVM default format.
      void setDisableFilter​(java.lang.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​(java.lang.Boolean enableMobileHeader)
      When true, the mobile header is enabled.
      void setEnableRipple​(java.lang.Boolean enableRipple)
      When true it will create a wave/ripple effect on elements specified by rippleElements.
      void setEnableSlideMenu​(java.lang.Boolean enableSlideMenu)
      If true will make left menu touch enable (can be closed or opened via touch).
      void setExtensionLessUrls​(java.lang.Boolean extensionLessUrls)
      Removes extension suffix from breadCrumb links.
      void setIconsEffect​(java.lang.Boolean iconsEffect)
      Enables material effect when icons (e.g modal close, calendar) are clicked.
      void setIgnoredResources​(java.lang.String ignoredResources)
      Comma separated resources (pages or urls) to be skiped by AdminFilter.
      void setIndexPage​(java.lang.String indexPage)
      index page location.
      void setLoadingImage​(java.lang.String loadingImage)
      image used for the loading popup.
      void setLoginPage​(java.lang.String loginPage)
      login page location (relative to webapp).
      void setMessagesHideTimeout​(java.lang.String messagesHideTimeout)
      Timeout to hide info messages.
      void setRenderAjaxStatus​(java.lang.Boolean renderAjaxStatus)
      When false ajaxStatus, which triggers the loading bar on every ajax request, will not be rendered.
      void setRenderBreadCrumb​(java.lang.Boolean renderBreadCrumb)
      When false, the breadCrumb component, declared in admin template, will not be rendered.
      void setRenderControlSidebar​(java.lang.Boolean renderControlSidebar)
      When true it will activate control sidebar component.
      void setRenderFormAsterisks​(java.lang.Boolean renderFormAsterisks)
      When true, the asterisk on required form elements is rendered.
      void setRenderMenuSearch​(java.lang.Boolean renderMenuSearch)
      Enables or disables menu search.
      void setRenderMessages​(java.lang.Boolean renderMessages)
      When false, p:messages defined in admin template will not be rendered.
      void setRippleElements​(java.lang.String rippleElements)
      A list of comma separated list of (jquery) selector which elements will be affected by ripple effect.
      void setRippleMobileOnly​(java.lang.Boolean rippleMobileOnly)
      When true the ripple effect will be enabled only on mobile (small) screens.
      void setSkin​(java.lang.String skin)
      Default template skin.
      void setSkipMessageDetailIfEqualsSummary​(java.lang.Boolean skipMessageDetailIfEqualsSummary)
      When true, p:message will not show details if equals to summary.
      void setTemplatePath​(java.lang.String templatePath)
      Template path.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • AdminfacesProperties

        public AdminfacesProperties()

    • Method Detail

      • getLoginPage

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

      • getIndexPage

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

      • getDateFormat

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

      • getTemplatePath

        public java.lang.String getTemplatePath()
        Template path.

      • getBreadcrumbSize

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

      • getRenderMessages

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

      • getSkipMessageDetailIfEqualsSummary

        public java.lang.Boolean getSkipMessageDetailIfEqualsSummary()
        When true, p:message will not show details if equals to summary.

      • getRenderAjaxStatus

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

      • getDisableFilter

        public java.lang.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 java.lang.Boolean getRenderBreadCrumb()
        When false, the breadCrumb component, declared in admin template, will not be rendered.

      • getEnableSlideMenu

        public java.lang.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 java.lang.Boolean getEnableRipple()
        When true it will create a wave/ripple effect on elements specified by rippleElements.

      • getRippleElements

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

      • getSkin

        public java.lang.String getSkin()
        Default template skin.

      • getAutoShowNavbar

        public java.lang.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 java.lang.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 java.lang.String getLoadingImage()
        image used for the loading popup. It must be under webapp/resources/images folder.

      • getExtensionLessUrls

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

      • getRenderControlSidebar

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

      • getRippleMobileOnly

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

      • getRenderMenuSearch

        public java.lang.Boolean getRenderMenuSearch()
        Enables or disables menu search.

      • getAutoHideMessages

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

      • getMessagesHideTimeout

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

      • getIconsEffect

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

      • getRenderFormAsterisks

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

      • getClosableLoading

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

      • getEnableMobileHeader

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

      • setLoginPage

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

      • setIndexPage

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

      • setDateFormat

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

      • setTemplatePath

        public void setTemplatePath​(java.lang.String templatePath)
        Template path.

      • setBreadcrumbSize

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

      • setRenderMessages

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

      • setSkipMessageDetailIfEqualsSummary

        public void setSkipMessageDetailIfEqualsSummary​(java.lang.Boolean skipMessageDetailIfEqualsSummary)
        When true, p:message will not show details if equals to summary.

      • setRenderAjaxStatus

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

      • setDisableFilter

        public void setDisableFilter​(java.lang.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​(java.lang.Boolean renderBreadCrumb)
        When false, the breadCrumb component, declared in admin template, will not be rendered.

      • setEnableSlideMenu

        public void setEnableSlideMenu​(java.lang.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​(java.lang.Boolean enableRipple)
        When true it will create a wave/ripple effect on elements specified by rippleElements.

      • setRippleElements

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

      • setSkin

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

      • setAutoShowNavbar

        public void setAutoShowNavbar​(java.lang.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​(java.lang.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​(java.lang.String loadingImage)
        image used for the loading popup. It must be under webapp/resources/images folder.

      • setExtensionLessUrls

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

      • setRenderControlSidebar

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

      • setRippleMobileOnly

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

      • setRenderMenuSearch

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

      • setAutoHideMessages

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

      • setMessagesHideTimeout

        public void setMessagesHideTimeout​(java.lang.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​(java.lang.Boolean iconsEffect)
        Enables material effect when icons (e.g modal close, calendar) are clicked.

      • setRenderFormAsterisks

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

      • setClosableLoading

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

      • setEnableMobileHeader

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

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • canEqual

        protected boolean canEqual​(java.lang.Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object