com.arsdigita.ui.login
Class UserSingleSelectionModel

java.lang.Object
  extended bycom.arsdigita.bebop.AbstractSingleSelectionModel
      extended bycom.arsdigita.ui.login.UserSingleSelectionModel
All Implemented Interfaces:
Lockable, SingleSelectionModel

public class UserSingleSelectionModel
extends AbstractSingleSelectionModel

A SingleSelectionModel that returns the user id.

Version:
1.0
Author:
Phong Nguyen, Sameer Ajmani

Field Summary
static String versionId
           
 
Constructor Summary
UserSingleSelectionModel()
           
 
Method Summary
 Object getSelectedKey(PageState state)
          Returns the key that identifies the selected element.
 ParameterModel getStateParameter()
          Returns the state parameter that will be used to keep track of the currently selected key.
 void setSelectedKey(PageState state, Object key)
          Sets the selected key.
 
Methods inherited from class com.arsdigita.bebop.AbstractSingleSelectionModel
addChangeListener, clearSelection, fireStateChanged, isLocked, isSelected, lock, removeChangeListener
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Constructor Detail

UserSingleSelectionModel

public UserSingleSelectionModel()
Method Detail

getSelectedKey

public Object getSelectedKey(PageState state)
Description copied from interface: SingleSelectionModel
Returns the key that identifies the selected element.

Specified by:
getSelectedKey in interface SingleSelectionModel
Specified by:
getSelectedKey in class AbstractSingleSelectionModel

setSelectedKey

public void setSelectedKey(PageState state,
                           Object key)
Description copied from interface: SingleSelectionModel
Sets the selected key. If key is not in the collection of objects underlying this model, an IllegalArgumentException is thrown.

Specified by:
setSelectedKey in interface SingleSelectionModel
Specified by:
setSelectedKey in class AbstractSingleSelectionModel

getStateParameter

public ParameterModel getStateParameter()
Description copied from interface: SingleSelectionModel
Returns the state parameter that will be used to keep track of the currently selected key. Typically, the implementing class will simply call:
return new StringParameter("foo");

This method may return null if a state parameter is not appropriate in the context of the implementing class.

Returns:
the state parameter to use to keep track of the currently selected component, or null if a state parameter is not appropriate.


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2337 UTC