org.apache.batik.apps.svgbrowser

Class ElementOverlayManager

public class ElementOverlayManager extends Object

Manages element overlay on the canvas.

Nested Class Summary
class	ElementOverlayManager.ElementOverlay The element overlay.

Field Summary
protected JSVGCanvas	canvas The canvas.
protected ElementOverlayController	controller The controller for the element overlay.
protected Overlay	elementOverlay The element overlay.
protected Color	elementOverlayColor The color of the element overlay.
protected Color	elementOverlayStrokeColor The color of the outline of the element overlay.
protected ArrayList	elements Elements to paint.
protected boolean	isOverlayEnabled Whether the ElementOverlay is enabled.
protected boolean	xorMode The xor mode.

Constructor Summary
	ElementOverlayManager(JSVGCanvas canvas) Constructor.

Method Summary
void	addElement(Element elem) Adds an element to the element selection.
protected Rectangle	getAllElementsBounds() Get the current selection bounds.
protected Rectangle	getElementBounds(Element elem) The bounds of a given element.
protected Rectangle	getElementBounds(GraphicsNode node) The bounds of a given graphics node.
Overlay	getElementOverlay() Gets the elementOverlay.
Color	getElementOverlayColor() Gets the elementOverlayColor.
Color	getElementOverlayStrokeColor() Gets the elementOverlayStrokeColor.
boolean	isOverlayEnabled() If the element overlay is enabled.
boolean	isXorMode() Gets the xorMode.
protected Rectangle	outset(Rectangle r, int amount) Increases the given rectangle area for a given amount of units in a rectangle increasement manner.
void	removeElement(Element elem) Removes the element from the element selection and adds its bound to the 'dirty' region.
void	removeElements() Removes all elements from the element selection list.
void	removeOverlay() Removes the elementOverlay.
void	repaint() Repaints the canvas.
void	setController(ElementOverlayController controller) Sets the element overlay controller.
void	setElementOverlayColor(Color selectionOverlayColor) Sets the color to use for the element overlay.
void	setElementOverlayStrokeColor(Color selectionOverlayStrokeColor) Sets the color to use for stroking the element overlay.
void	setOverlayEnabled(boolean isOverlayEnabled) Enables / disables the Element overlay.
void	setXorMode(boolean xorMode) Sets the xor mode.

Field Detail

canvas

protected JSVGCanvas canvas

The canvas.

controller

protected ElementOverlayController controller

The controller for the element overlay.

elementOverlay

protected Overlay elementOverlay

The element overlay.

elementOverlayColor

protected Color elementOverlayColor

The color of the element overlay.

elementOverlayStrokeColor

protected Color elementOverlayStrokeColor

The color of the outline of the element overlay.

elements

protected ArrayList elements

Elements to paint.

isOverlayEnabled

protected boolean isOverlayEnabled

Whether the ElementOverlay is enabled.

xorMode

protected boolean xorMode

The xor mode.

Constructor Detail

ElementOverlayManager

public ElementOverlayManager(JSVGCanvas canvas)

Constructor.

Parameters: canvas The parent canvas

Method Detail

addElement

public void addElement(Element elem)

Adds an element to the element selection.

Parameters: elem The element to add

getAllElementsBounds

protected Rectangle getAllElementsBounds()

Get the current selection bounds.

Returns: the current selection bounds

getElementBounds

protected Rectangle getElementBounds(Element elem)

The bounds of a given element.

Parameters: elem The given element

Returns: Rectangle bounds

getElementBounds

protected Rectangle getElementBounds(GraphicsNode node)

The bounds of a given graphics node.

Parameters: node The given graphics node

Returns: the bounds

getElementOverlay

public Overlay getElementOverlay()

Gets the elementOverlay.

Returns: the elementOverlay

getElementOverlayColor

public Color getElementOverlayColor()

Gets the elementOverlayColor.

Returns: the elementOverlayColor

getElementOverlayStrokeColor

public Color getElementOverlayStrokeColor()

Gets the elementOverlayStrokeColor.

Returns: the elementOverlayStrokeColor

isOverlayEnabled

public boolean isOverlayEnabled()

If the element overlay is enabled.

Returns: isOverlayEnabled

isXorMode

public boolean isXorMode()

Gets the xorMode.

Returns: the xorMode

outset

protected Rectangle outset(Rectangle r, int amount)

Increases the given rectangle area for a given amount of units in a rectangle increasement manner.

Parameters: r The given rectangle amount The given amount of units

Returns: r

removeElement

public void removeElement(Element elem)

Removes the element from the element selection and adds its bound to the 'dirty' region.

Parameters: elem The element to remove

removeElements

public void removeElements()

Removes all elements from the element selection list.

removeOverlay

public void removeOverlay()

Removes the elementOverlay.

repaint

public void repaint()

Repaints the canvas.

setController

public void setController(ElementOverlayController controller)

Sets the element overlay controller.

Parameters: controller The element overlay controller

setElementOverlayColor

public void setElementOverlayColor(Color selectionOverlayColor)

Sets the color to use for the element overlay.

Parameters: selectionOverlayColor The new element overlay color.

setElementOverlayStrokeColor

public void setElementOverlayStrokeColor(Color selectionOverlayStrokeColor)

Sets the color to use for stroking the element overlay.

Parameters: selectionOverlayStrokeColor The new element overlay stroking color.

setOverlayEnabled

public void setOverlayEnabled(boolean isOverlayEnabled)

Enables / disables the Element overlay.

setXorMode

public void setXorMode(boolean xorMode)

Sets the xor mode.

Parameters: xorMode the xorMode to set