Package com.vaadin.data.util

Class PropertysetItem

java.lang.Object

com.vaadin.data.util.PropertysetItem

All Implemented Interfaces:

Item, Item.PropertySetChangeNotifier, Serializable, Cloneable

Direct Known Subclasses:

BeanItem

public class PropertysetItem
extends Object
implements Item, Item.PropertySetChangeNotifier, Cloneable

Class for handling a set of identified Properties. The elements contained in a MapItem can be referenced using locally unique identifiers. The class supports listeners who are interested in changes to the Property set managed by the class.

Since:

3.0

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.Item

Item.Editor, Item.PropertySetChangeListener, Item.PropertySetChangeNotifier, Item.Viewer

Constructor Summary

Constructors

Constructor	Description
PropertysetItem()

Method Summary

Modifier and Type	Method	Description
boolean	addItemProperty(Object id, Property property)	Tries to add a new Property into the Item.
void	addListener(Item.PropertySetChangeListener listener)	Deprecated. As of 7.0, replaced by addPropertySetChangeListener(Item.PropertySetChangeListener)
void	addPropertySetChangeListener(Item.PropertySetChangeListener listener)	Registers a new property set change listener for this Item.
Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)
Property	getItemProperty(Object id)	Gets the Property corresponding to the given Property ID stored in the Item.
Collection<?>	getItemPropertyIds()	Gets the collection of IDs of all Properties stored in the Item.
Collection<?>	getListeners(Class<?> eventType)
int	hashCode()
boolean	removeItemProperty(Object id)	Removes the Property identified by ID from the Item.
void	removeListener(Item.PropertySetChangeListener listener)	Deprecated. As of 7.0, replaced by removePropertySetChangeListener(Item.PropertySetChangeListener)
void	removePropertySetChangeListener(Item.PropertySetChangeListener listener)	Removes a previously registered property set change listener.
String	toString()	Gets the String representation of the contents of the Item.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertysetItem

public PropertysetItem()

Method Detail

getItemProperty

public Property getItemProperty(Object id)

Gets the Property corresponding to the given Property ID stored in the Item. If the Item does not contain the Property, null is returned.

Specified by:

getItemProperty in interface Item

Parameters:

id - the identifier of the Property to get.

Returns:

the Property with the given ID or null

getItemPropertyIds

public Collection<?> getItemPropertyIds()

Gets the collection of IDs of all Properties stored in the Item.

Specified by:

getItemPropertyIds in interface Item

Returns:

unmodifiable collection containing IDs of the Properties stored the Item

removeItemProperty

public boolean removeItemProperty(Object id)

Removes the Property identified by ID from the Item. This functionality is optional. If the method is not implemented, the method always returns false.

Specified by:

removeItemProperty in interface Item

Parameters:

id - the ID of the Property to be removed.

Returns:

true if the operation succeeded false if not

addItemProperty

public boolean addItemProperty(Object id,
                               Property property)

Tries to add a new Property into the Item.

Specified by:

addItemProperty in interface Item

Parameters:

id - the ID of the new Property.

property - the Property to be added and associated with the id.

Returns:

true if the operation succeeded, false if not

toString

public String toString()

Gets the String representation of the contents of the Item. The format of the string is a space separated catenation of the String representations of the Properties contained by the Item.

Overrides:

toString in class Object

Returns:

String representation of the Item contents

addPropertySetChangeListener

public void addPropertySetChangeListener(Item.PropertySetChangeListener listener)

Registers a new property set change listener for this Item.

Specified by:

addPropertySetChangeListener in interface Item.PropertySetChangeNotifier

Parameters:

listener - the new Listener to be registered.

addListener

@Deprecated
public void addListener(Item.PropertySetChangeListener listener)

Deprecated.

As of 7.0, replaced by addPropertySetChangeListener(Item.PropertySetChangeListener)

Specified by:

addListener in interface Item.PropertySetChangeNotifier

removePropertySetChangeListener

public void removePropertySetChangeListener(Item.PropertySetChangeListener listener)

Removes a previously registered property set change listener.

Specified by:

removePropertySetChangeListener in interface Item.PropertySetChangeNotifier

Parameters:

listener - the Listener to be removed.

removeListener

@Deprecated
public void removeListener(Item.PropertySetChangeListener listener)

Deprecated.

As of 7.0, replaced by removePropertySetChangeListener(Item.PropertySetChangeListener)

Specified by:

removeListener in interface Item.PropertySetChangeNotifier

getListeners

public Collection<?> getListeners(Class<?> eventType)

clone

public Object clone()
             throws CloneNotSupportedException

Creates and returns a copy of this object.

The method clone performs a shallow copy of the PropertysetItem.

Note : All arrays are considered to implement the interface Cloneable. Otherwise, this method creates a new instance of the class of this object and initializes all its fields with exactly the contents of the corresponding fields of this object, as if by assignment, the contents of the fields are not themselves cloned. Thus, this method performs a "shallow copy" of this object, not a "deep copy" operation.

Overrides:

clone in class Object

Throws:

CloneNotSupportedException - if the object's class does not support the Cloneable interface.

See Also:

Object.clone()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object