public interface ListHolderStateObject<T> extends StateObject
ListHolderStateObject
is a StateObject
having a list of children and this
gives access to some operation over the list.Modifier and Type | Method and Description |
---|---|
<S extends T> |
addItem(S item)
Adds the given
StateObject as a child of this one. |
void |
addItems(java.util.List<? extends T> items)
Adds the given list of
StateObjects as children of this one. |
void |
addListChangeListener(java.lang.String listName,
IListChangeListener<T> listener)
Registers the given
IListChangeListener for the specified list. |
boolean |
canMoveDown(T item)
Determines whether the given
StateObject can be moved down by one position in the
list owned by its parent. |
boolean |
canMoveUp(T item)
Determines whether the given
StateObject can be moved up by one position in the list
owned by its parent. |
T |
getItem(int index)
Returns the
StateObject at the given positions from the list |
boolean |
hasItems()
Determines whether this
StateObject has any children. |
ListIterable<? extends T> |
items()
Returns an
IterableListIterator over the children. |
int |
itemsSize()
Returns the number of children this list holder has.
|
T |
moveDown(T item)
Moves the given
StateObject down by one position in the list owned by its parent. |
T |
moveUp(T item)
Moves the given
StateObject up by one position in the list owned by its parent. |
void |
removeItem(T item)
Removes the given
StateObject from the list of children. |
void |
removeItems(java.util.Collection<T> items)
Removes the given
StateObject from the list of children. |
void |
removeListChangeListener(java.lang.String listName,
IListChangeListener<T> listener)
Unregisters the given
IListChangeListener that was registered for the specified list. |
accept, addPropertyChangeListener, children, decorate, findIdentificationVariable, getDeclaration, getDecorator, getExpression, getGrammar, getManagedTypeProvider, getParent, getQueryBuilder, getRoot, isDecorated, isEquivalent, removePropertyChangeListener, setParent, toString, toText
<S extends T> S addItem(S item)
StateObject
as a child of this one.item
- The child StateObject
to become a child of this one
return The given itemvoid addItems(java.util.List<? extends T> items)
StateObjects
as children of this one.items
- The StateObjects
to become children of this onevoid addListChangeListener(java.lang.String listName, IListChangeListener<T> listener)
IListChangeListener
for the specified list. The listener will be
notified only when items are added, removed, moved from the list.listName
- The name of the list for which the listener will be notified when the content
of the list has changedlistener
- The listener to be notified upon changesjava.lang.NullPointerException
- IListChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener is already registered with the list nameboolean canMoveDown(T item)
StateObject
can be moved down by one position in the
list owned by its parent.item
- The StateObject
that could potentially be moved downtrue
if the object can be moved down by one unit; false
otherwiseboolean canMoveUp(T item)
StateObject
can be moved up by one position in the list
owned by its parent.item
- The StateObject
that could potentially be moved uptrue
if the object can be moved up by one unit; false
otherwiseT getItem(int index)
StateObject
at the given positions from the listindex
- The position of the StateObject
to retrieveStateObject
at the given positionboolean hasItems()
StateObject
has any children.true
if this StateObject
has children; false
otherwiseListIterable<? extends T> items()
IterableListIterator
over the children.IterableListIterator
that is iterating over the childrenint itemsSize()
StateObjects
that are children of this oneT moveDown(T item)
StateObject
down by one position in the list owned by its parent.item
- The StateObject
to move down in the listT moveUp(T item)
StateObject
up by one position in the list owned by its parent.item
- The StateObject
to move up in the listvoid removeItem(T item)
StateObject
from the list of children.item
- The child StateObject
to not longer be a childvoid removeItems(java.util.Collection<T> items)
StateObject
from the list of children.items
- The StateObjects
to remove from this onevoid removeListChangeListener(java.lang.String listName, IListChangeListener<T> listener)
IListChangeListener
that was registered for the specified list.
The listener will no longer be notified only when items are added, removed, moved from the
list.listName
- The name of the list for which the listener was registeredlistener
- The listener to unregisterjava.lang.NullPointerException
- IListChangeListener
cannot be null
java.lang.IllegalArgumentException
- The listener was never registered with the list name