Package org.opencms.xml.content

Class CmsXmlContentProperty

java.lang.Object
org.opencms.xml.content.CmsXmlContentProperty
All Implemented Interfaces:
Serializable
public class CmsXmlContentProperty extends Object implements Serializable
Describes both VFS properties and Container Page Element settings, used by the GWT client.

Warning: This class is used by GWT client-side code (See GwtBase.gwt.xml for a list of classes used by GWT client-side code). If you change this class, either make sure that your changes are compatible with GWT, or write a separate client version of the class and put it into super_src.

Since:
8.0.0
See Also:

  • Field Details

  • Constructor Details

    • CmsXmlContentProperty

      public CmsXmlContentProperty(String name, String type, String widget, String widgetConfiguration, String ruleRegex, String ruleType, String default1, String niceName, String description, String error, String preferFolder)
      Public constructor.

      Parameters:
      name - the property name
      type - the property type (string|uri)
      widget - the widget
      widgetConfiguration - the widget configuration
      ruleRegex - the validation rule regex
      ruleType - the validation rule type
      default1 - the default value
      niceName - the nice-name
      description - the description
      error - the error message
      preferFolder - the "prefer folder" option

    • CmsXmlContentProperty

      public CmsXmlContentProperty(String name, String aliasName, String type, CmsXmlContentProperty.Visibility visibility, String widget, String widgetConfiguration, String ruleRegex, String ruleType, String default1, String niceName, String description, String error, String preferFolder, String translation)
      Public constructor.

      Parameters:
      name - the property name
      aliasName - the alias name (can also contain multiple aliases separated by pipes)
      type - the property type (string|uri)
      visibility - the visibility of the property, used in the container page element context
      widget - the widget
      widgetConfiguration - the widget configuration
      ruleRegex - the validation rule regex
      ruleType - the validation rule type
      default1 - the default value
      niceName - the nice-name
      description - the description
      error - the error message
      preferFolder - the "prefer folder" option
      translation - the value translation string (newval1:oldval1|newval2:oldval2|...)

    • CmsXmlContentProperty

      protected CmsXmlContentProperty()
      Serialization constructor.

  • Method Details

    • copy

      public CmsXmlContentProperty copy()
      Copies this property definition.

      Returns:
      a new copy of the current property definition

    • getAliasName

      public String getAliasName()
      Gets the alias name (can also be a list of alias names separated by pipes).
      Returns:
      the alias name(s)

    • getConfiguredVisibility

      public CmsXmlContentProperty.Visibility getConfiguredVisibility()
      Gets the configured visibility, without using a default value.
      Returns:
      the configured visibility

    • getConfiguredWidget

      public String getConfiguredWidget()
      Gets the configured widget, without using a default if it is null.

      Returns:
      the configured widget

    • getDefault

      public String getDefault()
      Returns the default.

      Returns:
      the default

    • getDescription

      public String getDescription()
      Returns the description.

      Returns:
      the description

    • getError

      public String getError()
      Returns the error.

      Returns:
      the error

    • getIncludeName

      public String getIncludeName(String defaultValue)
      Gets the include name.

      This is only used for element settings in formatters, where defaults from setting configuration files can be imported. The returned value is used to look up the setting name to look up for such an import in the setting configuration file.

      Parameters:
      defaultValue - the value that should be returned if no include name is configured
      Returns:
      the include name

    • getName

      public String getName()
      Returns the property name.

      Returns:
      the property name

    • getNiceName

      public String getNiceName()
      Returns the niceName.

      Returns:
      the niceName

    • getRuleRegex

      public String getRuleRegex()
      Returns the ruleRegex.

      Returns:
      the ruleRegex

    • getRuleType

      public String getRuleType()
      Returns the rule type.

      Returns:
      the rule type

    • getSelectInherit

      public String getSelectInherit()
      Returns a value which indicates whether the user can control the inheritance of this property.

      Returns:
      the "select-inherit" property

    • getTranslationStr

      public String getTranslationStr()
      Gets the value translation string, which has the form newval1:oldval1|newval2:oldval2|... .
      Returns:
      the value translation string

    • getType

      public String getType()
      Returns the property type.

      Returns:
      the property type

    • getVisibility

      public CmsXmlContentProperty.Visibility getVisibility(CmsXmlContentProperty.Visibility defaultValue)
      Returns the visibility of the property, used in the container page element context.

      Parameters:
      defaultValue - the default value to return if the visibility is not set
      Returns:
      the visibility of the property

    • getWidget

      public String getWidget()
      Returns the widget.

      Returns:
      the widget

    • getWidgetConfiguration

      public String getWidgetConfiguration()
      Returns the widgetConfiguration.

      Returns:
      the widgetConfiguration

    • isPreferFolder

      public boolean isPreferFolder()
      Returns the value of the "prefer folder" option.

      This flag determines whether a property entered in the sitemap entry editor should be stored by default at the folder or at the default file of a sitemap entry. It only has an effect if the sitemap entry being edited doesn't already have a value for that property at either location.

      Returns:
      the "prefer folder" flag

    • mergeDefaults

      public CmsXmlContentProperty mergeDefaults(CmsXmlContentProperty defaults)
      Merges this object with another one containing default values.

      This method does not modify this object or the object passed as a parameter. The resulting object's fields will be filled with the values from the default if they're null in this object.

      Parameters:
      defaults - the object with the defaults
      Returns:
      the result of merging this object with the defaults

    • withConfig

      public CmsXmlContentProperty withConfig(String config)
      Returns a modified copy of this bean with a different widget configuration.

      Parameters:
      config - the new widget configuration
      Returns:
      the copy with the modified widget configuration

    • withDefaultWidget

      public CmsXmlContentProperty withDefaultWidget(String defaultWidget)
      Copies a property definition, but replaces an empty widget with a given widget.

      Parameters:
      defaultWidget - the widget to use if the set widget is empty
      Returns:
      the copied property definition

    • withIncludeName

      public CmsXmlContentProperty withIncludeName(String includeName)
      Creates a copy of this object with its include name set to a specific value.

      Parameters:
      includeName - the include name to use
      Returns:
      the copy with the include name set

    • withName

      public CmsXmlContentProperty withName(String name)
      Copies a property definition, but replaces the nice name attribute.

      Parameters:
      name - the new nice name attribute
      Returns:
      the copied property definition

    • withNiceName

      public CmsXmlContentProperty withNiceName(String niceName)
      Copies a property definition, but replaces the nice name attribute.

      Parameters:
      niceName - the new nice name attribute
      Returns:
      the copied property definition

    • withValidation

      public CmsXmlContentProperty withValidation(String pattern, String type, String error)
      Copies the property definition, but replaces the fields related to validation.
      Parameters:
      pattern - the validation pattern
      type - the validation type
      error - the validation error message
      Returns:
      the copied property definition