Package org.opencms.workplace.editors

Class CmsDialogElement

java.lang.Object

org.opencms.workplace.editors.CmsDialogElement

All Implemented Interfaces:

Comparable<CmsDialogElement>

public class CmsDialogElement
extends Object
implements Comparable<CmsDialogElement>

Contains the setup information about a single dialog element.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsDialogElement(String name, String niceName, boolean mandantory, boolean templateElement, boolean existing)	Creates a new dialog element.

Method Summary

Modifier and Type	Method	Description
int	compareTo(CmsDialogElement obj)
boolean	equals(Object obj)
String	getName()	Returns the name.
String	getNiceName()	Returns the niceName.
int	hashCode()
boolean	isExisting()	Returns the existing.
boolean	isMandantory()	Returns the mandatory.
boolean	isTemplateElement()	Returns true if the element is defined by the template, false if the element is just contained in the xml page code.
void	setExisting(boolean existing)	Sets the existing.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsDialogElement

public CmsDialogElement(String name,
 String niceName,
 boolean mandantory,
 boolean templateElement,
 boolean existing)

Creates a new dialog element.

Parameters:

name - the (system) name of the element

niceName - the nice "display" name of the element

mandantory - indicates if the element is mandatory

templateElement - indicates if the element is defined as template-element

existing - indicates if the element is existing on the xmlPage or not

Method Details

compareTo

public int compareTo(CmsDialogElement obj)

Specified by:

compareTo in interface Comparable<CmsDialogElement>

See Also:

• Comparable.compareTo(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

getName

public String getName()

Returns the name.

Returns:

the name

getNiceName

public String getNiceName()

Returns the niceName.

Returns:

the niceName

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

isExisting

public boolean isExisting()

Returns the existing.

Returns:

the existing

isMandantory

public boolean isMandantory()

Returns the mandatory.

Returns:

the mandatory

isTemplateElement

public boolean isTemplateElement()

Returns true if the element is defined by the template, false if the element is just contained in the xml page code.

Returns:

true if the element is defined by the template

setExisting

public void setExisting(boolean existing)

Sets the existing.

Parameters:

existing - the existing to set