org.apache.pivot.wtk.content
Class ListViewItemEditor

java.lang.Object
  extended by org.apache.pivot.wtk.content.ListViewItemEditor
All Implemented Interfaces:
Editor, ListView.ItemEditor

public class ListViewItemEditor
extends Object
implements ListView.ItemEditor

Default list view item editor.


Constructor Summary
ListViewItemEditor()
           
 
Method Summary
 void cancel()
          Cancels an edit that is in progress by reverting any edits the user has made.
 void edit(ListView listView, int index)
          Notifies the editor that editing should begin.
protected  TextInput getEditor()
          Gets the text input that serves as the editor component.
 boolean isEditing()
          Tells whether or not an edit is currently in progress.
 void save()
          Saves an edit that is in progress by updating the appropriate data object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ListViewItemEditor

public ListViewItemEditor()
Method Detail

getEditor

protected final TextInput getEditor()
Gets the text input that serves as the editor component. This component will only be non-null while editing.

Returns:
This editor's component, or null if an edit is not in progress
See Also:
isEditing()

edit

public void edit(ListView listView,
                 int index)
Notifies the editor that editing should begin. If the editor is currently installed on the list view, the skin may choose to call this method when the user executes the appropriate gesture (as defined by the skin).

Specified by:
edit in interface ListView.ItemEditor
Parameters:
listView - The list view
index - The index of the item to edit
See Also:
ListView.setItemEditor(ItemEditor)

isEditing

public boolean isEditing()
Description copied from interface: Editor
Tells whether or not an edit is currently in progress.

Specified by:
isEditing in interface Editor

save

public void save()
Saves an edit that is in progress by updating the appropriate data object. It is up to subclasses to define the behavior when isEditing() == false.

Specified by:
save in interface Editor

cancel

public void cancel()
Description copied from interface: Editor
Cancels an edit that is in progress by reverting any edits the user has made. It is up to subclasses to define the behavior when isEditing() == false.

Specified by:
cancel in interface Editor