Package org.ametys.runtime.model

Class ViewElement

java.lang.Object

org.ametys.runtime.model.ViewElement

All Implemented Interfaces:

ModelViewItem<ElementDefinition>, ViewItem, Labelable, ModifiableLabelable

Direct Known Subclasses:

ViewElementAccessor, ViewElementSearchUIColumn

public class ViewElement
extends Object
implements ModelViewItem<ElementDefinition>

View reference to an element definition

Constructor Summary

Constructors

Constructor	Description
ViewElement()

Method Summary

Modifier and Type	Method	Description
void	copyTo(ViewItem item)	Copy the current view item in the given one.
ViewElement	createInstance()	Create an instance of ViewItem
boolean	equals(Object obj)
boolean	equals(Object obj, boolean checkDetails)	Indicates whether some other object is "equal to" this one.
ElementDefinition	getDefinition()	Retrieves the referenced model item definition
I18nizableText	getDescription()	Retrieves the description.
I18nizableText	getLabel()	Retrieves the label.
String	getName()	Get the name.
ViewItemAccessor	getParent()	Retrieves the parent of the view item
int	hashCode()
void	setDefinition(ElementDefinition definition)	Sets the referenced model item definition
void	setDescription(I18nizableText description)	Set the description.
void	setLabel(I18nizableText label)	Set the label.
void	setParent(ViewItemAccessor parent)	Sets the parent of the view item
Map<String,Object>	toJSON(DefinitionContext context)	Converts the view item in a JSON map
void	toSAX(ContentHandler contentHandler, DefinitionContext context)	Generates SAX events for the view item
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.ModelViewItem

setName

Methods inherited from interface org.ametys.runtime.model.ViewItem

copyTo

Constructor Details

ViewElement

public ViewElement()

Method Details

getDefinition

public ElementDefinition getDefinition()

Description copied from interface: ModelViewItem

Retrieves the referenced model item definition

Specified by:

getDefinition in interface ModelViewItem<ElementDefinition>

Returns:

the referenced definition

setDefinition

public void setDefinition(ElementDefinition definition)

Description copied from interface: ModelViewItem

Sets the referenced model item definition

Specified by:

setDefinition in interface ModelViewItem<ElementDefinition>

Parameters:

definition - the referenced definition

getParent

public ViewItemAccessor getParent()

Description copied from interface: ViewItem

Retrieves the parent of the view item

Specified by:

getParent in interface ViewItem

Returns:

the parent group

setParent

public void setParent(ViewItemAccessor parent)

Description copied from interface: ViewItem

Sets the parent of the view item

Specified by:

setParent in interface ViewItem

Parameters:

parent - the parent to set

getName

public String getName()

Description copied from interface: Labelable

Get the name.

Specified by:

getName in interface Labelable

Returns:

the name.

setLabel

public void setLabel(I18nizableText label)

Description copied from interface: ModifiableLabelable

Set the label.

Specified by:

setLabel in interface ModifiableLabelable

Parameters:

label - the label.

setDescription

public void setDescription(I18nizableText description)

Description copied from interface: ModifiableLabelable

Set the description.

Specified by:

setDescription in interface ModifiableLabelable

Parameters:

description - the description.

getLabel

public I18nizableText getLabel()

Description copied from interface: Labelable

Retrieves the label.

Specified by:

getLabel in interface Labelable

Returns:

the label.

getDescription

public I18nizableText getDescription()

Description copied from interface: Labelable

Retrieves the description.

Specified by:

getDescription in interface Labelable

Returns:

the description.

toJSON

public Map<String,Object> toJSON(DefinitionContext context)
                          throws ProcessingException

Description copied from interface: ViewItem

Converts the view item in a JSON map

Specified by:

toJSON in interface ViewItem

Parameters:

context - the context of the definitions referenced in this view item and/or its children

Returns:

The view item as a JSON map

Throws:

ProcessingException - If an error occurs when converting the view item

toSAX

public void toSAX(ContentHandler contentHandler,
 DefinitionContext context)
           throws SAXException

Description copied from interface: ViewItem

Generates SAX events for the view item

Specified by:

toSAX in interface ViewItem

Parameters:

contentHandler - the ContentHandler that will receive the SAX events

context - the context of the definitions included in the view item

Throws:

SAXException - if an error occurs during the SAX events generation

copyTo

public void copyTo(ViewItem item)

Description copied from interface: ViewItem

Copy the current view item in the given one. If the view item is an accessor, its view items are not copied

Specified by:

copyTo in interface ViewItem

Parameters:

item - the copy

createInstance

public ViewElement createInstance()

Description copied from interface: ViewItem

Create an instance of ViewItem

Specified by:

createInstance in interface ViewItem

Returns:

the created instance

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(Object obj,
 boolean checkDetails)

Description copied from interface: ViewItem

Indicates whether some other object is "equal to" this one.

Specified by:

equals in interface ViewItem

Parameters:

obj - the reference object with which to compare.

checkDetails - true to check the view item's details during comparison (label, description, ...)

Returns:

true if this object is the same as the given obj, false otherwise.

toString

public String toString()

Overrides:

toString in class Object