Package org.ametys.runtime.model

Class ViewElementAccessor

java.lang.Object

org.ametys.runtime.model.ViewElement

org.ametys.runtime.model.ViewElementAccessor

All Implemented Interfaces:

ModelViewItem<ElementDefinition>, ViewItem, ViewItemAccessor, Labelable, ModifiableLabelable

Direct Known Subclasses:

ViewElementAccessorSearchUIColumn

public class ViewElementAccessor
extends ViewElement
implements ViewItemAccessor

View element that can access to other view items

Constructor Summary

Constructors

Constructor	Description
ViewElementAccessor()

Method Summary

Modifier and Type	Method	Description
void	addViewItem(ViewItem item)	Add a view item in the accessor
void	clear()	Removes all items of this accessor
void	copyTo(ViewItem item, ViewItemAccessor referenceViewItemAccessor, String itemPath)	Copy the current view item in the given one.
ViewElementAccessor	createInstance()	Create an instance of ViewItem
boolean	equals(Object obj)
List<ViewItem>	getViewItems()	Retrieves all the view items of this accessor
int	hashCode()
void	insertViewItem(ViewItem item, int index)	Insert a view item in the accessor at the given index
static ViewElementAccessor	of(ModelItemAccessor modelItemAccessor)	Creates a ViewElementAccessor with the items of the given ModelItemAccessor
static ViewElementAccessor	of(ModelItemAccessor modelItemAccessor, String... itemPaths)	Creates a ViewElementAccessor with the given items
boolean	removeViewItem(ViewItem item)	Removes the given items of this accessor
String	toString()

Methods inherited from class org.ametys.runtime.model.ViewElement

copyTo, equals, getDefinition, getDescription, getLabel, getName, getParent, setDefinition, setDescription, setLabel, setParent, toJSON, toSAX

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.ViewItemAccessor

addViewItems, getModelViewItem, getViewItem, hasModelViewItem, hasModelViewItem, hasModelViewItem

Constructor Details

ViewElementAccessor

public ViewElementAccessor()

Method Details

getViewItems

public List<ViewItem> getViewItems()

Description copied from interface: ViewItemAccessor

Retrieves all the view items of this accessor

Specified by:

getViewItems in interface ViewItemAccessor

Returns:

the view items

addViewItem

public void addViewItem(ViewItem item)

Description copied from interface: ViewItemAccessor

Add a view item in the accessor

Specified by:

addViewItem in interface ViewItemAccessor

Parameters:

item - the item to add

insertViewItem

public void insertViewItem(ViewItem item,
 int index)

Description copied from interface: ViewItemAccessor

Insert a view item in the accessor at the given index

Specified by:

insertViewItem in interface ViewItemAccessor

Parameters:

item - the item to insert

index - index at which the item has to be inserted

removeViewItem

public boolean removeViewItem(ViewItem item)

Description copied from interface: ViewItemAccessor

Removes the given items of this accessor

Specified by:

removeViewItem in interface ViewItemAccessor

Parameters:

item - the item to remove

Returns:

true if this accessor contained the given item, false otherwise

clear

public void clear()

Description copied from interface: ViewItemAccessor

Removes all items of this accessor

Specified by:

clear in interface ViewItemAccessor

of

public static ViewElementAccessor of(ModelItemAccessor modelItemAccessor)
                              throws IllegalArgumentException

Creates a ViewElementAccessor with the items of the given ModelItemAccessor

Parameters:

modelItemAccessor - the model item accessor

Returns:

the created ViewElementAccessor

Throws:

IllegalArgumentException - if the model item accessor is null

of

public static ViewElementAccessor of(ModelItemAccessor modelItemAccessor,
 String... itemPaths)
                              throws IllegalArgumentException,
BadItemTypeException

Creates a ViewElementAccessor with the given items

Parameters:

modelItemAccessor - the model item accessing the items definitions

itemPaths - the paths of the items to put in the view item

Returns:

the created ViewElementAccessor

Throws:

IllegalArgumentException - if the model item accessor is null or if an item path is null, empty, or is not defined in the given model items

BadItemTypeException - if a segment in a path (but not the last) does not represent a group item

copyTo

public void copyTo(ViewItem item,
 ViewItemAccessor referenceViewItemAccessor,
 String itemPath)

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 copied only if they are not already present in the reference ViewItemAccessor

Specified by:

copyTo in interface ViewItem

Parameters:

item - the copy

referenceViewItemAccessor - the reference ViewItemAccessor

itemPath - the path of the view item relative to the reference ViewItemAccessor

createInstance

public ViewElementAccessor createInstance()

Description copied from interface: ViewItem

Create an instance of ViewItem

Specified by:

createInstance in interface ViewItem

Overrides:

createInstance in class ViewElement

Returns:

the created instance

hashCode

public int hashCode()

Overrides:

hashCode in class ViewElement

equals

public boolean equals(Object obj)

Overrides:

equals in class ViewElement

toString

public String toString()

Overrides:

toString in class ViewElement