java.lang.Object
javax.swing.tree.DefaultTreeCellEditor
- All Implemented Interfaces:
ActionListener
,EventListener
,CellEditor
,TreeSelectionListener
,TreeCellEditor
public class DefaultTreeCellEditor
extends Object
implements ActionListener, TreeCellEditor, TreeSelectionListener
A
TreeCellEditor
. You need to supply an
instance of DefaultTreeCellRenderer
so that the icons can be obtained. You can optionally supply
a TreeCellEditor
that will be laid out according
to the icon in the DefaultTreeCellRenderer
.
If you do not supply a TreeCellEditor
,
a TextField
will be used. Editing is started
on a triple mouse click, or after a click, pause, click and
a delay of 1200 milliseconds.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeans
has been added to the java.beans
package.
Please see XMLEncoder
.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
TextField
used when no editor is supplied.class
Container responsible for placing theeditingComponent
. -
Field Summary
Modifier and TypeFieldDescriptionprotected Color
True if the border selection color should be drawn.protected boolean
As of Java 2 platform v1.4 this field should no longer be used.protected Component
Component used in editing, obtained from theeditingContainer
.protected Container
Editing container, will contain theeditorComponent
.protected Icon
Icon to use when editing.protected Font
Font to paint with,null
indicates font of renderer is to be used.protected TreePath
Last path that was selected.protected int
Row that was last passed intogetTreeCellEditorComponent
.protected int
Used in editing.protected TreeCellEditor
Editor handling the editing.protected DefaultTreeCellRenderer
Renderer, used to get border and offsets from.protected Timer
Used before starting the editing session.protected JTree
JTree
instance listening too. -
Constructor Summary
ConstructorDescriptionDefaultTreeCellEditor
(JTree tree, DefaultTreeCellRenderer renderer) Constructs aDefaultTreeCellEditor
object for a JTree using the specified renderer and a default editor.DefaultTreeCellEditor
(JTree tree, DefaultTreeCellRenderer renderer, TreeCellEditor editor) Constructs aDefaultTreeCellEditor
object for aJTree
using the specified renderer and the specified editor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Messaged when the timer fires, this will start the editing session.void
Adds theCellEditorListener
.void
MessagescancelCellEditing
to therealEditor
and removes it from this instance.protected boolean
canEditImmediately
(EventObject event) Returns true ifevent
isnull
, or it is aMouseEvent
with a click count > 2 andinHitRegion
returns true.protected Container
Creates the container to manage placement ofeditingComponent
.protected TreeCellEditor
This is invoked if aTreeCellEditor
is not supplied in the constructor.protected void
determineOffset
(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row) Determine the offset.Returns the color the border is drawn.Returns an array of all theCellEditorListener
s added to this DefaultTreeCellEditor with addCellEditorListener().Returns the value currently being edited.getFont()
Gets the font used for editing.getTreeCellEditorComponent
(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row) Configures the editor.protected boolean
inHitRegion
(int x, int y) Returns true if the passed in location is a valid mouse location to start editing from.boolean
isCellEditable
(EventObject event) If therealEditor
returns true to this message,prepareForEditing
is messaged and true is returned.protected void
Invoked just before editing is to start.void
Removes the previously addedCellEditorListener
.void
setBorderSelectionColor
(Color newColor) Sets the color to use for the border.void
Sets the font to edit with.protected void
Sets the tree currently editing for.boolean
shouldSelectCell
(EventObject event) Messages therealEditor
for the return value.protected boolean
Returns true ifevent
is aMouseEvent
and the click count is 1.protected void
Starts the editing timer.boolean
If therealEditor
will allow editing to stop, therealEditor
is removed and true is returned, otherwise false is returned.void
ResetslastPath
.
-
Field Details
-
realEditor
Editor handling the editing. -
renderer
Renderer, used to get border and offsets from. -
editingContainer
Editing container, will contain theeditorComponent
. -
editingComponent
Component used in editing, obtained from theeditingContainer
. -
canEdit
protected boolean canEditAs of Java 2 platform v1.4 this field should no longer be used. If you wish to provide similar behavior you should directly overrideisCellEditable
. -
offset
protected transient int offsetUsed in editing. Indicates x position to placeeditingComponent
. -
tree
JTree
instance listening too. -
lastPath
Last path that was selected. -
timer
Used before starting the editing session. -
lastRow
protected transient int lastRowRow that was last passed intogetTreeCellEditorComponent
. -
borderSelectionColor
True if the border selection color should be drawn. -
editingIcon
Icon to use when editing. -
font
Font to paint with,null
indicates font of renderer is to be used.
-
-
Constructor Details
-
DefaultTreeCellEditor
Constructs aDefaultTreeCellEditor
object for a JTree using the specified renderer and a default editor. (Use this constructor for normal editing.)- Parameters:
tree
- aJTree
objectrenderer
- aDefaultTreeCellRenderer
object
-
DefaultTreeCellEditor
Constructs aDefaultTreeCellEditor
object for aJTree
using the specified renderer and the specified editor. (Use this constructor for specialized editing.)- Parameters:
tree
- aJTree
objectrenderer
- aDefaultTreeCellRenderer
objecteditor
- aTreeCellEditor
object
-
-
Method Details
-
setBorderSelectionColor
Sets the color to use for the border.- Parameters:
newColor
- the new border color
-
getBorderSelectionColor
Returns the color the border is drawn.- Returns:
- the border selection color
-
setFont
Sets the font to edit with.null
indicates the renderers font should be used. This will NOT override any font you have set in the editor the receiver was instantiated with. Ifnull
for an editor was passed in a default editor will be created that will pick up this font.- Parameters:
font
- the editingFont
- See Also:
-
getFont
Gets the font used for editing.- Returns:
- the editing
Font
- See Also:
-
getTreeCellEditorComponent
public Component getTreeCellEditorComponent(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row) Configures the editor. Passed onto therealEditor
.- Specified by:
getTreeCellEditorComponent
in interfaceTreeCellEditor
- Parameters:
tree
- the JTree that is asking the editor to edit; this parameter can be nullvalue
- the value of the cell to be editedisSelected
- true if the cell is to be rendered with selection highlightingexpanded
- true if the node is expandedleaf
- true if the node is a leaf noderow
- the row index of the node being edited- Returns:
- the component for editing
-
getCellEditorValue
Returns the value currently being edited.- Specified by:
getCellEditorValue
in interfaceCellEditor
- Returns:
- the value currently being edited
-
isCellEditable
If therealEditor
returns true to this message,prepareForEditing
is messaged and true is returned.- Specified by:
isCellEditable
in interfaceCellEditor
- Parameters:
event
- the event the editor should use to consider whether to begin editing or not- Returns:
- true if editing can be started
- See Also:
-
shouldSelectCell
Messages therealEditor
for the return value.- Specified by:
shouldSelectCell
in interfaceCellEditor
- Parameters:
event
- the event the editor should use to start editing- Returns:
- true if the editor would like the editing cell to be selected; otherwise returns false
- See Also:
-
stopCellEditing
public boolean stopCellEditing()If therealEditor
will allow editing to stop, therealEditor
is removed and true is returned, otherwise false is returned.- Specified by:
stopCellEditing
in interfaceCellEditor
- Returns:
- true if editing was stopped; false otherwise
-
cancelCellEditing
public void cancelCellEditing()MessagescancelCellEditing
to therealEditor
and removes it from this instance.- Specified by:
cancelCellEditing
in interfaceCellEditor
-
addCellEditorListener
Adds theCellEditorListener
.- Specified by:
addCellEditorListener
in interfaceCellEditor
- Parameters:
l
- the listener to be added
-
removeCellEditorListener
Removes the previously addedCellEditorListener
.- Specified by:
removeCellEditorListener
in interfaceCellEditor
- Parameters:
l
- the listener to be removed
-
getCellEditorListeners
Returns an array of all theCellEditorListener
s added to this DefaultTreeCellEditor with addCellEditorListener().- Returns:
- all of the
CellEditorListener
s added or an empty array if no listeners have been added - Since:
- 1.4
-
valueChanged
ResetslastPath
.- Specified by:
valueChanged
in interfaceTreeSelectionListener
- Parameters:
e
- the event that characterizes the change.
-
actionPerformed
Messaged when the timer fires, this will start the editing session.- Specified by:
actionPerformed
in interfaceActionListener
- Parameters:
e
- the event to be processed
-
setTree
Sets the tree currently editing for. This is needed to add a selection listener.- Parameters:
newTree
- the new tree to be edited
-
shouldStartEditingTimer
Returns true ifevent
is aMouseEvent
and the click count is 1.- Parameters:
event
- the event being studied- Returns:
- whether
event
should starts the editing timer
-
startEditingTimer
protected void startEditingTimer()Starts the editing timer. -
canEditImmediately
Returns true ifevent
isnull
, or it is aMouseEvent
with a click count > 2 andinHitRegion
returns true.- Parameters:
event
- the event being studied- Returns:
- whether editing can be started for the given
event
-
inHitRegion
protected boolean inHitRegion(int x, int y) Returns true if the passed in location is a valid mouse location to start editing from. This is implemented to return false ifx
is <= the width of the icon and icon gap displayed by the renderer. In other words this returns true if the user clicks over the text part displayed by the renderer, and false otherwise.- Parameters:
x
- the x-coordinate of the pointy
- the y-coordinate of the point- Returns:
- true if the passed in location is a valid mouse location
-
determineOffset
protected void determineOffset(JTree tree, Object value, boolean isSelected, boolean expanded, boolean leaf, int row) Determine the offset.- Parameters:
tree
- aJTree
objectvalue
- a valueisSelected
- selection statusexpanded
- expansion statusleaf
- leaf statusrow
- current row
-
prepareForEditing
protected void prepareForEditing()Invoked just before editing is to start. Will add theeditingComponent
to theeditingContainer
. -
createContainer
Creates the container to manage placement ofeditingComponent
.- Returns:
- new Container object
-
createTreeCellEditor
This is invoked if aTreeCellEditor
is not supplied in the constructor. It returns aTextField
editor.- Returns:
- a new
TextField
editor
-