Package org.opencms.configuration.preferences

Class CmsPreferenceData

  • public class CmsPreferenceData
extends java.lang.Object
    Bean representing the configurable attributes for a preference.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsPreferenceData​(java.lang.String name, java.lang.String value, CmsXmlContentProperty prop, java.lang.String tab)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultValue()
      Gets the default value for the preference.
      java.lang.String getName()
      Gets the name of the preference.
      CmsXmlContentProperty getPropertyDefinition()
      Gets the preference definition.
      java.lang.String getTab()
      Gets the tab on which the preference should be displayed.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • CmsPreferenceData

        public CmsPreferenceData​(java.lang.String name,
                         java.lang.String value,
                         CmsXmlContentProperty prop,
                         java.lang.String tab)
        Creates a new instance.

        Parameters:
        name - the preference name
        value - the preference value
        prop - the preference configuration
        tab - the tab on which to display the preference

    • Method Detail

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Gets the default value for the preference.

        Returns:
        the default value for the preference

      • getName

        public java.lang.String getName()
        Gets the name of the preference.

        Returns:
        the preference name

      • getTab

        public java.lang.String getTab()
        Gets the tab on which the preference should be displayed.

        Returns:
        the tab on which the preference should be displayed