Package org.opencms.ade.configuration

Class CmsPropertyConfig

java.lang.Object

org.opencms.ade.configuration.CmsPropertyConfig

All Implemented Interfaces:

java.lang.Cloneable, I_CmsConfigurationObject<CmsPropertyConfig>

public class CmsPropertyConfig
extends java.lang.Object
implements I_CmsConfigurationObject<CmsPropertyConfig>, java.lang.Cloneable

This class represents the property configuration for a sitemap region.

(This is mostly a wrapper around CmsXmlContentProperty. We don't use that class directly because we may want to put server-specific logic in here, and CmsXmlContentProperty is used as a bean for RPC data transfer to the client.)

Since:

8.0.1

Version:

$Revision: 1.0 $

Author:

Georg Westenberger

Field Summary

Fields inherited from interface org.opencms.ade.configuration.I_CmsConfigurationObject

DEFAULT_ORDER

Constructor Summary

Constructors

Constructor	Description
CmsPropertyConfig(CmsXmlContentProperty propData, boolean disabled)	Creates a new propery configuration bean.
CmsPropertyConfig(CmsXmlContentProperty propData, boolean disabled, int order)	Creates a new property configuration bean.

Method Summary

Modifier and Type	Method	Description
CmsPropertyConfig	clone()
CmsPropertyConfig	cloneWithTop(boolean top)	Creates a clone and sets the 'top' property in the clone.
java.lang.String	getKey()	The name of the configuration object.
java.lang.String	getName()	Gets the name of the property.
int	getOrder()	Gets the order.
CmsXmlContentProperty	getPropertyData()	Returns the property configuration data.
boolean	isDisabled()	Returns true if the entry disables a property, rather than adding it.
boolean	isTop()	Returns true if this is a 'top property' which should be displayed near the top of a property list.
CmsPropertyConfig	merge(CmsPropertyConfig child)	Merges this configuration object with a child configuration object.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CmsPropertyConfig

public CmsPropertyConfig(CmsXmlContentProperty propData,
                         boolean disabled)

Creates a new propery configuration bean.

Parameters:

propData - the property data

disabled - true if this property is disabled

CmsPropertyConfig

public CmsPropertyConfig(CmsXmlContentProperty propData,
                         boolean disabled,
                         int order)

Creates a new property configuration bean.

Parameters:

propData - the property data

disabled - true if this property is disabled

order - the number used for sorting the property configurations

Method Detail

clone

public CmsPropertyConfig clone()

Overrides:

clone in class java.lang.Object

See Also:

Object.clone()

cloneWithTop

public CmsPropertyConfig cloneWithTop(boolean top)

Creates a clone and sets the 'top' property in the clone.

Parameters:

top - the value for the top property in the clone

Returns:

the clone

getKey

public java.lang.String getKey()

Description copied from interface: I_CmsConfigurationObject

The name of the configuration object.

This name should be unique for each single configuration

Specified by:

getKey in interface I_CmsConfigurationObject<CmsPropertyConfig>

Returns:

the name

See Also:

I_CmsConfigurationObject.getKey()

getName

public java.lang.String getName()

Gets the name of the property.

Returns:

the name of the property

getOrder

public int getOrder()

Gets the order.

Returns:

the order

getPropertyData

public CmsXmlContentProperty getPropertyData()

Returns the property configuration data.

Returns:

the property configuration data

isDisabled

public boolean isDisabled()

Returns true if the entry disables a property, rather than adding it.

Specified by:

isDisabled in interface I_CmsConfigurationObject<CmsPropertyConfig>

Returns:

true if the property should be disabled

isTop

public boolean isTop()

Returns true if this is a 'top property' which should be displayed near the top of a property list.

Returns:

true if this is a top property

merge

public CmsPropertyConfig merge(CmsPropertyConfig child)

Description copied from interface: I_CmsConfigurationObject

Merges this configuration object with a child configuration object.

Specified by:

merge in interface I_CmsConfigurationObject<CmsPropertyConfig>

Parameters:

child - the child configuration object

Returns:

the merged configuration objects

See Also:

I_CmsConfigurationObject.merge(org.opencms.ade.configuration.I_CmsConfigurationObject)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()