org.gnu.gtk.event

Class TreeViewEvent

Implemented Interfaces:
Serializable

public class TreeViewEvent
extends GtkEvent

An event represeting action by a TreeView widget.
See Also:
TreeView

Nested Class Summary

static class
TreeViewEvent.Type
Which type of TreeModelEvent was received

Constructor Summary

TreeViewEvent(Object source, TreeViewEvent.Type type)
Creates a new TreeView Event.

Method Summary

int
getHowMany()
If the event signal was GTK's "move-cursor" (ie MOVE_CURSOR) then
MovementStep
getMovementStep()
If the event signal was GTK's "move-cursor" (ie MOVE_CURSOR) then
TreeViewColumn
getTreeColumn()
TreeIter
getTreeIter()
TreePath
getTreePath()
boolean
isExpand()
boolean
isLogical()
boolean
isOfType(TreeViewEvent.Type aType)
boolean
isOpenAll()
boolean
isStartEditing()
void
setExpand(boolean expand)
void
setHowMany(int howMany)
Internal method for use by event handlers in TreeView only.
void
setLogical(boolean logical)
void
setMovementStep(MovementStep movementStep)
Internal method for use by event handlers in TreeView only.
void
setOpenAll(boolean openAll)
void
setStartEditing(boolean startEditing)
void
setTreeColumn(TreeViewColumn treeColumn)
void
setTreeIter(TreeIter iter)
void
setTreePath(TreePath path)

Methods inherited from class org.gnu.gtk.event.GtkEvent

getSource, getType, toString

Constructor Details

TreeViewEvent

public TreeViewEvent(Object source,
                     TreeViewEvent.Type type)
Creates a new TreeView Event. This is used internally by java-gnome. Users only have to deal with listeners.

Method Details

getHowMany

public int getHowMany()
Returns:
the number of MovementSteps that occured. This is typically 1.

getMovementStep

public MovementStep getMovementStep()
If the event signal was GTK's "move-cursor" (ie MOVE_CURSOR) then
Returns:
the MovementSteps type that occured. You can expect MovementStep.DISPLAY_LINES for an Up/Down arrow press, MovementStep.PAGES for a PageUp/PageDown press, and MovementStep.BUFFER_ENDS for Home/End being presesd.

getTreeColumn

public TreeViewColumn getTreeColumn()
Returns:
Returns the treeColumn.

getTreeIter

public TreeIter getTreeIter()
Returns:
Returns the iter.

getTreePath

public TreePath getTreePath()
Returns:
Returns the path.

isExpand

public boolean isExpand()
Returns:
Returns the expand.

isLogical

public boolean isLogical()
Returns:
Returns the logical.

isOfType

public boolean isOfType(TreeViewEvent.Type aType)
Returns:
True if the type of this event is the same as that stated.

isOpenAll

public boolean isOpenAll()
Returns:
Returns the openAll.

isStartEditing

public boolean isStartEditing()
Returns:
Returns the startEditing.

setExpand

public void setExpand(boolean expand)
Parameters:
expand - The expand to set.

setHowMany

public void setHowMany(int howMany)
Parameters:
howMany - set how many Movement Steps occured based on the gint arg2 value passed up from GTK on a "move-cursor" event signal.

setLogical

public void setLogical(boolean logical)
Parameters:
logical - The logical to set.

setMovementStep

public void setMovementStep(MovementStep movementStep)
Internal method for use by event handlers in TreeView only.
Parameters:
movementStep - set the MovementStep object you created based on GtkMovementStep arg1 value passed up from GTK on a "move-cursor" event signal.

setOpenAll

public void setOpenAll(boolean openAll)
Parameters:
openAll - The openAll to set.

setStartEditing

public void setStartEditing(boolean startEditing)
Parameters:
startEditing - The startEditing to set.

setTreeColumn

public void setTreeColumn(TreeViewColumn treeColumn)
Parameters:
treeColumn - The treeColumn to set.

setTreeIter

public void setTreeIter(TreeIter iter)
Parameters:
iter - The iter to set.

setTreePath

public void setTreePath(TreePath path)
Parameters:
path - The path to set.