org.opencms.xml.content

Class CmsXmlContentProperty

java.lang.Object

org.opencms.xml.content.CmsXmlContentProperty

All Implemented Interfaces:

java.io.Serializable

public class CmsXmlContentProperty
extends java.lang.Object
implements java.io.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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CmsXmlContentProperty.PropType Type constants.
static class	CmsXmlContentProperty.XmlNode XML node name constants.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_SEPARATOR IDs separator constant.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CmsXmlContentProperty() Serialization constructor.
	CmsXmlContentProperty(java.lang.String name, java.lang.String type, java.lang.String widget, java.lang.String widgetConfiguration, java.lang.String ruleRegex, java.lang.String ruleType, java.lang.String default1, java.lang.String niceName, java.lang.String description, java.lang.String error, java.lang.String preferFolder) Public constructor.

Method Summary

Methods

Modifier and Type	Method and Description
CmsXmlContentProperty	copy() Copies this property definition.
java.lang.String	getDefault() Returns the default.
java.lang.String	getDescription() Returns the description.
java.lang.String	getError() Returns the error.
java.lang.String	getName() Returns the property name.
java.lang.String	getNiceName() Returns the niceName.
java.lang.String	getRuleRegex() Returns the ruleRegex.
java.lang.String	getRuleType() Returns the rule type.
java.lang.String	getSelectInherit() Returns a value which indicates whether the user can control the inheritance of this property.
java.lang.String	getType() Returns the property type.
java.lang.String	getWidget() Returns the widget.
java.lang.String	getWidgetConfiguration() Returns the widgetConfiguration.
boolean	isPreferFolder() Returns the value of the "prefer folder" option.
CmsXmlContentProperty	withDefaultWidget(java.lang.String defaultWidget) Copies a property definition, but replaces an empty widget with a given widget.
CmsXmlContentProperty	withNiceName(java.lang.String niceName) Copies a property definition, but replaces the nice name attribute.

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SEPARATOR

public static final java.lang.String PROP_SEPARATOR

IDs separator constant.

See Also:

Constant Field Values

Constructor Detail

CmsXmlContentProperty

public CmsXmlContentProperty(java.lang.String name,
                     java.lang.String type,
                     java.lang.String widget,
                     java.lang.String widgetConfiguration,
                     java.lang.String ruleRegex,
                     java.lang.String ruleType,
                     java.lang.String default1,
                     java.lang.String niceName,
                     java.lang.String description,
                     java.lang.String error,
                     java.lang.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

protected CmsXmlContentProperty()

Serialization constructor.

Method Detail

copy

public CmsXmlContentProperty copy()

Copies this property definition.

Returns:

a new copy of the current property definition

getDefault

public java.lang.String getDefault()

Returns the default.

Returns:

the default

getDescription

public java.lang.String getDescription()

Returns the description.

Returns:

the description

getError

public java.lang.String getError()

Returns the error.

Returns:

the error

getName

public java.lang.String getName()

Returns the property name.

Returns:

the property name

getNiceName

public java.lang.String getNiceName()

Returns the niceName.

Returns:

the niceName

getRuleRegex

public java.lang.String getRuleRegex()

Returns the ruleRegex.

Returns:

the ruleRegex

getRuleType

public java.lang.String getRuleType()

Returns the rule type.

Returns:

the rule type

getSelectInherit

public java.lang.String getSelectInherit()

Returns a value which indicates whether the user can control the inheritance of this property.

Returns:

the "select-inherit" property

getType

public java.lang.String getType()

Returns the property type.

Returns:

the property type

getWidget

public java.lang.String getWidget()

Returns the widget.

Returns:

the widget

getWidgetConfiguration

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

withDefaultWidget

public CmsXmlContentProperty withDefaultWidget(java.lang.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

withNiceName

public CmsXmlContentProperty withNiceName(java.lang.String niceName)

Copies a property definition, but replaces the nice name attribute.

Parameters:

niceName - the new nice name attribute

Returns:

the copied property definition