com.codename1.properties

Class ListProperty<T,K>

java.lang.Object

com.codename1.properties.PropertyBase<T,K>

com.codename1.properties.CollectionProperty<T,K>

com.codename1.properties.ListProperty<T,K>

All Implemented Interfaces:

Iterable<T>

public class ListProperty<T,K>
extends CollectionProperty<T,K>

Base class for a property as a list which can contain multiple elements within

Constructor Summary

Constructors

Constructor and Description
ListProperty(String name) Constructs a property with null value
ListProperty(String name, Class<T> elementType, T... values) Constructs a property with the given name and values by specifying the type of the elements explicitly.
ListProperty(String name, T... values) Constructs a property with the given name and value

Method Summary

Modifier and Type	Method and Description
K	add(int offset, T v) Adds a property value and fires a change event
K	add(T v) Adds a property value to the end of the list and fires a change event
K	addAll(Collection<? extends T> v) Adds a all properties value to the list and fires a change event
List<Object>	asExplodedList() Returns a copy of the content as a new list but if the value is a PropertyBusinessObject it will be converted to a Map
List<T>	asList() Returns a copy of the content as a new list
void	clear() Remove all the elements from the list
boolean	contains(T element) Returns true if the given element is contained in the list property
boolean	equals(Object obj) Compares this property to another property
T	get(int offset) Gets the property value
int	hashCode() Returns the internal hashcode or 0 for null property
int	indexOf(T element) Returns the index of the given element in the list property
Iterator<T>	iterator() Iterate over the elements of the property
K	remove(int offset) Removes the item at the given offset
K	remove(T v) Removes the item with this value
K	removeAll(Collection<? extends T> v) Removes from the list all values from the given collection and fires a change event if the list has changed
K	set(Collection<T> t) Sets the entire content of the property
K	set(int offset, T v) Sets the property value and potentially fires a change event
K	setList(Collection<T> t) Historical alias of set(Collection t) Sets the entire content of the property
int	size() The size of the property list

Methods inherited from class com.codename1.properties.PropertyBase

addChangeListener, bindGlobalGetListener, bindGlobalSetListener, firePropertyChanged, getClientProperty, getGenericType, getLabel, getName, putClientProperty, removeChangeListener, setLabel, stopListening, toString, validateCollectionType

Methods inherited from class java.lang.Object

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

Constructor Detail

ListProperty

public ListProperty(String name,
                    T... values)

Constructs a property with the given name and value

Parameters:

name - the name of the property

values - default values for the property

ListProperty

public ListProperty(String name,
                    Class<T> elementType,
                    T... values)

Constructs a property with the given name and values by specifying the type of the elements explicitly. The element type needs to be specified if the list should contain PropertyBusinessObjects and needs to get deserialized properly!

Parameters:

name - the name of the property

elementType - subclass of PropertyBusinessObject

values - default values for the property

ListProperty

public ListProperty(String name)

Constructs a property with null value

Parameters:

name - the name of the property

Method Detail

get

public T get(int offset)

Gets the property value

Parameters:

offset - the offset within the list

Returns:

the property value

size

public int size()

The size of the property list

Specified by:

size in class CollectionProperty<T,K>

Returns:

the number of elements

set

public K set(int offset,
             T v)

Sets the property value and potentially fires a change event

Parameters:

offset - the position for the new value

v - the new value

Returns:

the parent object for chaining

set

public K set(Collection<T> t)

Sets the entire content of the property

Specified by:

set in class CollectionProperty<T,K>

Parameters:

t - the collection of elements to set

Returns:

the parent object for chaining

setList

public K setList(Collection<T> t)

Historical alias of set(Collection t) Sets the entire content of the property

Parameters:

t - the collection of elements to set

Returns:

the parent object for chaining

add

public K add(int offset,
             T v)

Adds a property value and fires a change event

Parameters:

offset - the position for the new value

v - the new value

add

public K add(T v)

Adds a property value to the end of the list and fires a change event

Specified by:

add in class CollectionProperty<T,K>

Parameters:

v - the new value

addAll

public K addAll(Collection<? extends T> v)

Adds a all properties value to the list and fires a change event

Specified by:

addAll in class CollectionProperty<T,K>

Parameters:

v - the collection of values to add

remove

public K remove(int offset)

Removes the item at the given offset

Specified by:

remove in class CollectionProperty<T,K>

Parameters:

offset - the offset

remove

public K remove(T v)

Removes the item with this value

Specified by:

remove in class CollectionProperty<T,K>

Parameters:

v - the value object

removeAll

public K removeAll(Collection<? extends T> v)

Removes from the list all values from the given collection and fires a change event if the list has changed

Specified by:

removeAll in class CollectionProperty<T,K>

Parameters:

the - item to remove

equals

public boolean equals(Object obj)

Compares this property to another property

Overrides:

equals in class PropertyBase<T,K>

Parameters:

obj - the other property

Returns:

true if they are equal in name and value

hashCode

public int hashCode()

Returns the internal hashcode or 0 for null property

Overrides:

hashCode in class Object

Returns:

the hashcode value

iterator

public Iterator<T> iterator()

Iterate over the elements of the property

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in class CollectionProperty<T,K>

Returns:

an iterator

asList

public List<T> asList()

Returns a copy of the content as a new list

Specified by:

asList in class CollectionProperty<T,K>

Returns:

a list

asExplodedList

public List<Object> asExplodedList()

Returns a copy of the content as a new list but if the value is a PropertyBusinessObject it will be converted to a Map

Specified by:

asExplodedList in class CollectionProperty<T,K>

Returns:

a list

clear

public void clear()

Remove all the elements from the list

Specified by:

clear in class CollectionProperty<T,K>

contains

public boolean contains(T element)

Returns true if the given element is contained in the list property

Specified by:

contains in class CollectionProperty<T,K>

Parameters:

element - the element

Returns:

true if the given element is contained in the list property

indexOf

public int indexOf(T element)

Returns the index of the given element in the list property

Parameters:

element - the element

Returns:

the index of the given element in the list property