com.xmlmind.xmledit.view

Class TreeView

java.lang.Object

com.xmlmind.xmledit.gadget.Gadget

com.xmlmind.xmledit.gadget.GadgetContainer

com.xmlmind.xmledit.view.TreeView

All Implemented Interfaces:

Command, CollapsibleGadget, ElementView, ElementViewPart, NodeView, NodeViewPart

Direct Known Subclasses:

StyledTreeView

public class TreeView
extends GadgetContainer
implements CollapsibleGadget, Command, ElementView, ElementViewPart

Nested Class Summary

Nested classes/interfaces inherited from class com.xmlmind.xmledit.gadget.GadgetContainer

GadgetContainer.Side

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	collapsed
Element	element
protected TreeViewSettings	settings

Fields inherited from class com.xmlmind.xmledit.gadget.GadgetContainer

children, NO_GADGETS

Fields inherited from class com.xmlmind.xmledit.gadget.Gadget

height, parent, width, x, y

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TreeView(Element element)
	TreeView(Element element, TreeViewSettings settings)

Method Summary

Modifier and Type	Method and Description
Gadget	addChildViewGadgets(NodeView childView, int viewIndex) Attaches to the gadget tree the gadgets used to render specified child view.
void	detachingFromModel(Document document, int viewIndex) Invoked by DocumentView to notify this view just before it is no longer used to graphically represent its node.
CommandResult	executeCommand(Gadget gadget, String parameter, int x, int y) Actually executes this command with specified parameter and in specified context.
Element	getElement() Returns the element which is represented graphically by this view.
ElementView	getElementView() Returns the view which is (at least partly) rendered by this gadget.
void	getGadgets(GadgetList gadgets, int viewIndex) Returns all gadgets that are used to render the view.
Node	getModel() Returns the node which is represented graphically by this view.
int[]	getNonBreakableVerticalRanges() Called by GadgetPrinter to know where page boundaries cannot occur.
TreeViewSettings	getSettings()
void	getSizeConstraints(Gadget child, Dimension constraints) Invoked by a child gadget before layouting itself to know what are the constraints for its width and height.
NodeView	getView() Returns the view which is (at least partly) rendered by this gadget.
boolean	grabsMouseButton(MouseEvent e) Invoked by EventDispatcher to know if this gadget has an action triggered by mouse button+modifiers of specified mouse event.
void	handleMouseEvent(MouseEvent e) Invoked by EventDispatcher to request this gadget to handle specified mouse event.
boolean	isCollapsed() Returns true if this gadget is collapsed; returns false otherwise.
boolean	isCollapsible() Returns true if this gadget can be collapsed; returns false otherwise.
boolean	isTreeView() Returns true if this view is rendered as a tree; false otherwise; This method is needed to implement styled view factories.
boolean	isTreeViewContainer() Returns true if this view can only contain child tree views; false otherwise; This method is needed to implement styled view factories.
void	layout(int constrainedWidth, int constrainedHeight, boolean recursive) Requests this gadget to relayout itself.
void	paint(Graphics g) Paint this gadget using specified Graphics object.
protected void	paint(Graphics g, Color backgroundColor)
void	paintRelayout(Gadget child, int prevWidth, int prevHeight, GadgetContainer.Side damagedSide, int damagedLength) Invoked by a child gadget when its geometry (width, height, but also for some gadgets baseline, reference point, etc) has changed.
boolean	prepareCommand(Gadget gadget, String parameter, int x, int y) Tests whether this command can be executed with specified parameter and in specified context.
void	print(Graphics g) Print this gadget using specified Graphics object.
Gadget	removeChildViewGadgets(NodeView childView, int viewIndex) Detaches from the gadget tree the gadgets used to render specified child view.
void	setCollapsed(boolean collapsed) Collapses/expands this gadget according to specified flag (if this gadget is in a state different from the one specified by the flag).

Methods inherited from class com.xmlmind.xmledit.gadget.GadgetContainer

addChild, findGadgetAt, getChild, getChildCount, getChildren, indexOfChild, indexOfChildAt, insertChild, isAncestorOf, paintRelayout, removeAllChildren, removeChild, removeChild, replaceChild, replaceChild

Methods inherited from class com.xmlmind.xmledit.gadget.Gadget

focusGained, focusLost, gadgetToPanel, gadgetToRoot, getAncestors, getBounds, getBounds, getCursor, getEventDispatcher, getFontMetrics, getGadgetPanel, getGraphics, getLocation, getLocation, getRoot, getSize, getSize, getToolkit, getToolTip, handleAppEvent, handleKeyEvent, hasFocus, isAppEventHandler, layout, makeRectangleVisible, makeRectangleVisible, panelToGadget, refresh, relayout, relayout, repaint, repaint, requestFocus

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xmlmind.xmledit.control.Command

copy

Field Detail

element

public final Element element

settings

protected TreeViewSettings settings

collapsed

protected boolean collapsed

Constructor Detail

TreeView

public TreeView(Element element,
                TreeViewSettings settings)

TreeView

protected TreeView(Element element)

Method Detail

getModel

public Node getModel()

Description copied from interface: NodeView

Returns the node which is represented graphically by this view.

Specified by:

getModel in interface NodeView

getGadgets

public void getGadgets(GadgetList gadgets,
                       int viewIndex)

Description copied from interface: NodeView

Returns all gadgets that are used to render the view.

For example, for elements displayed inline, it returns the gadgets that render the generated content for this inline (if any) plus all the gadgets that render the child views.

Only topmost gadgets needs to be returned by this method, that is, descendant gadgets of gadgets used to render this view need not be returned.

Specified by:

getGadgets in interface NodeView

Parameters:

gadgets - this method appends gadgets to this list to return its result

viewIndex - view index of the DocumentView ancestor of this view

detachingFromModel

public void detachingFromModel(Document document,
                               int viewIndex)

Description copied from interface: NodeView

Invoked by DocumentView to notify this view just before it is no longer used to graphically represent its node. (The reasons may be that user has changed the style sheet, rebuild the view, the node has been itself detached from the document, etc.)

Implemented by views that need to perform some sort of cleanup.

Specified by:

detachingFromModel in interface NodeView

Parameters:

document - document being represented by the DocumentView invoking this method

viewIndex - view index of the DocumentView invoking this method

getElement

public Element getElement()

Description copied from interface: ElementView

Returns the element which is represented graphically by this view.

Specified by:

getElement in interface ElementView

addChildViewGadgets

public Gadget addChildViewGadgets(NodeView childView,
                                  int viewIndex)

Description copied from interface: ElementView

Attaches to the gadget tree the gadgets used to render specified child view. For example, this element view could be rendered by a single GadgetContainer to which these gadgets are added.

Specified by:

addChildViewGadgets in interface ElementView

Parameters:

childView - child view for which gadgets are to be added

viewIndex - view index of the DocumentView ancestor of this view

Returns:

gadget that is to be refreshed or null if there is no such gadget

removeChildViewGadgets

public Gadget removeChildViewGadgets(NodeView childView,
                                     int viewIndex)

Description copied from interface: ElementView

Detaches from the gadget tree the gadgets used to render specified child view. For example, this element view could be rendered by a single GadgetContainer from which these gadgets are removed.

Specified by:

removeChildViewGadgets in interface ElementView

Parameters:

childView - child view for which gadgets are to be added

viewIndex - view index of the DocumentView ancestor of this view

Returns:

gadget that is to be refreshed or null if there is no such gadget

isTreeView

public boolean isTreeView()

Description copied from interface: ElementView

Returns true if this view is rendered as a tree; false otherwise;

This method is needed to implement styled view factories.

Specified by:

isTreeView in interface ElementView

See Also:

ElementView.isTreeViewContainer()

isTreeViewContainer

public boolean isTreeViewContainer()

Description copied from interface: ElementView

Returns true if this view can only contain child tree views; false otherwise;

This method is needed to implement styled view factories.

Specified by:

isTreeViewContainer in interface ElementView

See Also:

ElementView.isTreeView()

getView

public NodeView getView()

Description copied from interface: NodeViewPart

Returns the view which is (at least partly) rendered by this gadget.

Specified by:

getView in interface NodeViewPart

getElementView

public ElementView getElementView()

Description copied from interface: ElementViewPart

Returns the view which is (at least partly) rendered by this gadget. The view returned by this method is more strongly typed that the one returned by getView.

Specified by:

getElementView in interface ElementViewPart

See Also:

NodeViewPart.getView()

getSettings

public TreeViewSettings getSettings()

isCollapsible

public boolean isCollapsible()

Description copied from interface: CollapsibleGadget

Returns true if this gadget can be collapsed; returns false otherwise.

Specified by:

isCollapsible in interface CollapsibleGadget

setCollapsed

public void setCollapsed(boolean collapsed)

Description copied from interface: CollapsibleGadget

Collapses/expands this gadget according to specified flag (if this gadget is in a state different from the one specified by the flag). Does not refresh the gadget.

Specified by:

setCollapsed in interface CollapsibleGadget

See Also:

Gadget.refresh()

isCollapsed

public boolean isCollapsed()

Description copied from interface: CollapsibleGadget

Returns true if this gadget is collapsed; returns false otherwise.

Specified by:

isCollapsed in interface CollapsibleGadget

getSizeConstraints

public void getSizeConstraints(Gadget child,
                               Dimension constraints)

Description copied from class: GadgetContainer

Invoked by a child gadget before layouting itself to know what are the constraints for its width and height.

Specified by:

getSizeConstraints in class GadgetContainer

Parameters:

child - the child that invoked this method

constraints - this Dimension object is updated to reflect the contraints on the child size. A negative or null width or height means not constrained.

layout

public void layout(int constrainedWidth,
                   int constrainedHeight,
                   boolean recursive)

Description copied from class: Gadget

Requests this gadget to relayout itself.

This gadget responds by recomputing and updating its width and height.

Specified by:

layout in class Gadget

Parameters:

constrainedWidth - A stretchable gadget might be able to adapt its size to this constrained width. A negative or null value means not constrained.

constrainedHeight - A stretchable gadget might be able to adapt its size to this constrained height. A negative or null value means not constrained.

recursive - If true, recursively layout children too.

paintRelayout

public void paintRelayout(Gadget child,
                          int prevWidth,
                          int prevHeight,
                          GadgetContainer.Side damagedSide,
                          int damagedLength)

Description copied from class: GadgetContainer

Invoked by a child gadget when its geometry (width, height, but also for some gadgets baseline, reference point, etc) has changed.

This parent gadget must at least respond by repainting its child but generally this parent gadget has to ``refresh'' itself.

This default implementation is a kind of light-weight Gadget.refresh() where the relayout is not recursive. It should be redefined by a faster, more container specific, version.

This default implementation assumes that if, after the relayout, this container has not changed its width and height, a repaint is sufficient and its own parent doesn't need to be notified.

Overrides:

paintRelayout in class GadgetContainer

Parameters:

child - the child that invoked this method

prevWidth - child width before the relayout

prevHeight - child height before the relayout

damagedSide - the side, if any, that was expanded or shrinked

damagedLength - If damagedSide is GadgetContainer.Side.TOP, it is sufficient to repaint (0, 0, width, damagedLength).

If damagedSide is GadgetContainer.Side.BOTTOM, it is sufficient to repaint (0, height-damagedLength, width, damagedLength).

If damagedSide is GadgetContainer.Side.LEFT, it is sufficient to repaint (0, 0, damagedLength, height).

If damagedSide is GadgetContainer.Side.RIGHT, it is sufficient to repaint (width-damagedLength, 0, damagedLength, height).

If damagedSide is GadgetContainer.Side.NONE, (damagedLength is meaningless) repaint the whole child.

paint

public void paint(Graphics g)

Description copied from class: Gadget

Paint this gadget using specified Graphics object.

One cannot assume that any of the attributes of the Graphics object (background, foreground, font, etc) is properly set.

Overrides:

paint in class GadgetContainer

print

public void print(Graphics g)

Description copied from class: Gadget

Print this gadget using specified Graphics object.

One cannot assume that any of the attributes of the Graphics object (background, foreground, font, etc) is properly set.

Overrides:

print in class GadgetContainer

paint

protected void paint(Graphics g,
                     Color backgroundColor)

getNonBreakableVerticalRanges

public int[] getNonBreakableVerticalRanges()

Description copied from class: GadgetContainer

Called by GadgetPrinter to know where page boundaries cannot occur.

This implementation returns null which specifies that a page break can occur anywhere inside this container.

Overrides:

getNonBreakableVerticalRanges in class GadgetContainer

Returns:

a list of Y position pairs: non-breakable range start/non-breakable range end. Return null to specify that a page break can occur anywhere.

grabsMouseButton

public boolean grabsMouseButton(MouseEvent e)

Description copied from class: Gadget

Invoked by EventDispatcher to know if this gadget has an action triggered by mouse button+modifiers of specified mouse event.

The type of mouse event (CLICKED, PRESSED, DRAGGED, etc) is not relevant here. If a gadget ``grabs'' Shift+mouse button 1, it will receive all the following mouse events: PRESSED, DRAGGED, RELEASED, CLICKED, etc, through Gadget.handleMouseEvent(java.awt.event.MouseEvent).

Overrides:

grabsMouseButton in class Gadget

handleMouseEvent

public void handleMouseEvent(MouseEvent e)

Description copied from class: Gadget

Invoked by EventDispatcher to request this gadget to handle specified mouse event.

Overrides:

handleMouseEvent in class Gadget

prepareCommand

public boolean prepareCommand(Gadget gadget,
                              String parameter,
                              int x,
                              int y)

Description copied from interface: Command

Tests whether this command can be executed with specified parameter and in specified context.

If the command can be executed, this method returns true after having configured its internal state for consumption by method Command.executeCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) which should be invoked immediately after this one.

Returns false if this command cannot be executed with specified parameter and in specified context.

Specified by:

prepareCommand in interface Command

Parameters:

gadget - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

executeCommand

public CommandResult executeCommand(Gadget gadget,
                                    String parameter,
                                    int x,
                                    int y)

Description copied from interface: Command

Actually executes this command with specified parameter and in specified context.

This method assumes that Command.prepareCommand(com.xmlmind.xmledit.gadget.Gadget, java.lang.String, int, int) has been successfully invoked immediately before its own invocation.

Specified by:

executeCommand in interface Command

Parameters:

gadget - the target of this command

parameter - parameterizes the command (that is, modifies the behavior of the command in a command specific way)

x - X position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

y - Y position relative to gadget of the mouse event having triggered this command; -1 if this command was triggered by a keyboard input

Returns:

the result of the command; may NOT be null