Package org.opencms.workplace.editors
Class CmsDialogElement
- java.lang.Object
-
- org.opencms.workplace.editors.CmsDialogElement
-
- All Implemented Interfaces:
java.lang.Comparable<CmsDialogElement>
public class CmsDialogElement extends java.lang.Object implements java.lang.Comparable<CmsDialogElement>
Contains the setup information about a single dialog element.- Since:
- 6.0.0
-
-
Constructor Summary
Constructors Constructor Description CmsDialogElement(java.lang.String name, java.lang.String niceName, boolean mandantory, boolean templateElement, boolean existing)
Creates a new dialog element.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(CmsDialogElement obj)
boolean
equals(java.lang.Object obj)
java.lang.String
getName()
Returns the name.java.lang.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.
-
-
-
Constructor Detail
-
CmsDialogElement
public CmsDialogElement(java.lang.String name, java.lang.String niceName, boolean mandantory, boolean templateElement, boolean existing)
Creates a new dialog element.- Parameters:
name
- the (system) name of the elementniceName
- the nice "display" name of the elementmandantory
- indicates if the element is mandatorytemplateElement
- indicates if the element is defined as template-elementexisting
- indicates if the element is existing on the xmlPage or not
-
-
Method Detail
-
compareTo
public int compareTo(CmsDialogElement obj)
- Specified by:
compareTo
in interfacejava.lang.Comparable<CmsDialogElement>
- See Also:
Comparable.compareTo(java.lang.Object)
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
- See Also:
Object.equals(java.lang.Object)
-
getName
public java.lang.String getName()
Returns the name.- Returns:
- the name
-
getNiceName
public java.lang.String getNiceName()
Returns the niceName.- Returns:
- the niceName
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.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
-
-