org.kuali.student.common.ui.client.mvc
Class CollectionModel<T>

java.lang.Object
  org.kuali.student.common.ui.client.mvc.CollectionModel<T>

Type Parameters:

T - the type of model object to be contained within the model

All Implemented Interfaces:

Model

public class CollectionModel<T>
extends Object
implements Model

Model object used as a container for the model state. Sources ModelChangeEvents used for tracking the model state.

Author:

Kuali Student Team

Field Summary

private Map<String,T>	data
private com.google.gwt.event.shared.HandlerManager	handlers
private T	value

Constructor Summary

CollectionModel()

Method Summary

void	add(T object) Adds an object to the model, and fires a ModelChangeEvent
com.google.gwt.event.shared.HandlerRegistration	addModelChangeHandler(ModelChangeHandler handler) Adds a ModelChangeHandler that will be invoked for ModelChangeEvents
T	getValue() Returns the Model's value Going forward, the Model class should primarily be used with a single DataModel instance for use with the configurable UI framework.
Collection<T>	getValues() Returns an unsorted, umodifiable collection of the values contained within the model.
T	remove(T object) Deprecated. should use new Data structures instead, accessed via getValue, setValue
void	setValue(T value) Sets the Model's value Going forward, the Model class should primarily be used with a single DataModel instance for use with the configurable UI framework.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

data

private Map<String,T> data

handlers

private com.google.gwt.event.shared.HandlerManager handlers

value

private T value

Constructor Detail

CollectionModel

public CollectionModel()

Method Detail

add

public void add(T object)

Adds an object to the model, and fires a ModelChangeEvent

Parameters:

object -

remove

public T remove(T object)

Deprecated. should use new Data structures instead, accessed via getValue, setValue

Removes the specified model object from the model

Parameters:

object -

Returns:

the object that was removed, or null if not found

addModelChangeHandler

public com.google.gwt.event.shared.HandlerRegistration addModelChangeHandler(ModelChangeHandler handler)

Adds a ModelChangeHandler that will be invoked for ModelChangeEvents

Specified by:

addModelChangeHandler in interface Model

Parameters:

handler - the handler to add

Returns:

HandlerRegistration that can be used to unregister the handler later

getValues

public Collection<T> getValues()

Returns an unsorted, umodifiable collection of the values contained within the model.

Returns:

an unsorted, umodifiable collection of the values contained within the model.

getValue

public T getValue()

Returns the Model's value Going forward, the Model class should primarily be used with a single DataModel instance for use with the configurable UI framework.

Returns:

the Model's value

setValue

public void setValue(T value)

Sets the Model's value Going forward, the Model class should primarily be used with a single DataModel instance for use with the configurable UI framework.

Parameters:

value - the new value