org.arakhne.neteditor.swing

Class JFigureView<G extends Graph<?,?,?,?>>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.arakhne.afc.ui.swing.zoom.ZoomableView

org.arakhne.neteditor.swing.JFigureView<G>

Type Parameters:

G - is the type of the graph supported by this panel.

All Implemented Interfaces:

ImageObserver, MenuContainer, Printable, Serializable, Iterable<Figure>, Accessible, ZoomableContext, ViewComponentContainer<Figure,G>

public class JFigureView<G extends Graph<?,?,?,?>>
extends ZoomableView
implements ViewComponentContainer<Figure,G>

This class provides a viewer for manipulating graphical network The editor (JFigurePanel) is the central class of the graph editing framework. All the net-level models, graphical objects, layers, editor modes, editor commands, and supporting dialogs and frames are implemented in their own classes.

Version:

17.0 2013-10-23 21:03:09

Author:

Mahdi HANNOUN, Stéphane GALLAND, Marc BAUMGARTNER

See Also:

Serialized Form

Maven Group Id:

org.arakhne.neteditor

Maven Artifact Id:

neteditor-swingpanel

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLICK_PRECISION Precision in pixels for the clicking action (in pixels).
protected ReentrantLock	deletionLock Lock resource that may be used for deletion actions.

Fields inherited from class org.arakhne.afc.ui.swing.zoom.ZoomableView

REPAINT_BORDER

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
JFigureView(Class<G> supportedGraphType, G g, FigureFactory<G> figureFactory, boolean isAlwaysRemovingModelObjects) Construct a new JFigurePanel.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExceptionListener(ExceptionListener listener) Add listener on exceptions.
int	addFigure(Figure component) Add the element at the specified index.
void	addFigureListener(FigureListener listener) Add listener on figure events.
protected Rectangle2f	calcViewBounds() Compute and reply the bounds of the entire document.
(package private) void	closePopupEditor() Cancel and close the popup editor.
void	copy() Transfers the currently selected figures to the system clipboard, leaving the contents in the text model.
void	cut() Transfers the currently selected figures to the system clipboard, removing the contents from the model.
void	fireError(Throwable error) Notifies the listeners about an error that occurs in one of the JFigureEditor components.
protected void	fireFigureAdded(Figure added) Notifies the listeners about the addition of a figure.
protected void	fireFigureChanged(Figure changed) Notifies the listeners about the change of a figure.
protected void	fireFigureRemoved(Figure removed) Notifies the listeners about the removal of a figure.
Color	getBackgroundColor() Replies the background color of the panel.
CollisionAvoider	getCollisionAvoider() Replies the object that permits to avoid collision between a figure to insert inside and the already present figures.
Figure	getFigureAt(float x, float y) Replies the figure that has the specified point in its shape.
Figure	getFigureAt(int index) Replies the element at the specified index.
int	getFigureCount() Replies the number of components in this container.
FigureFactory<G>	getFigureFactory() Replies the figure factory used by this panel.
Figure	getFigureIn(Rectangle2f bounds) Replies the first figure that are inside the specified bounds.
Figure	getFigureOn(Shape2f bounds) Replies the first figure that are intersecting the specified bounds.
Collection<? extends Figure>	getFigures() Replies the figures in the container.
Set<Figure>	getFiguresIn(Rectangle2f bounds) Replies the figures that are inside the specified bounds.
Set<Figure>	getFiguresOn(Shape2f bounds) Replies the figures that are intersecting the specified bounds.
Figure	getFigureWithBoundsAt(float x, float y) Replies the figu with the precision re that has its bounds with the specified point inside.
G	getGraph() Replies the graph displayed in this viewer.
float	getHitPrecision() Replies the precision of the clicks (in pixels).
ActionModeManager	getModeManager() Replies the action mode manager used by this viewser.
protected float	getPreferredFocusX()
protected float	getPreferredFocusY()
Color	getSelectionBackground() Replies the background color used for the selection of objects.
Color	getSelectionBackgroundColor() Replies the background color associated to selection.
Color	getSelectionForeground() Replies the foreground color used for the selection of objects.
Color	getSelectionForegroundColor() Replies the foreground color associated to selection.
JSelectionManager	getSelectionManager() Replies the selection manager.
Class<G>	getSupportedGraphType() Replies the type of graph supported by this viewer.
UndoManagerSwing	getUndoManager() Replies the manager of undoable actions.
UUID	getUUID() Relies the id of the view.
Rectangle2f	getViewBounds() Replies the bounds of the view of the components.
Undoable	importFigure(DecorationFigure figure) Import the specified figure into this editor and replies an undoable edit.
Undoable	importGraph(String undoLabel, G graph, List<ViewComponent> figures) Import the graph and the specified figures into this editor.
Undoable	importGraph(String undoLabel, G graph, Map<UUID,List<ViewComponent>> figures) Import the graph and the specified figures into this editor.
int	indexOfFigure(Figure figure) Replies the index of the figure.
boolean	isAlwaysRemovingModelObjects() Replies if the mode container want to remove the model objects when a figure is removed from the view.
boolean	isAxisDrawn() Replies if the axis are drawn.
boolean	isEditable() Replies if this viewer is interactively editable.
boolean	isFigureAutomaticallyAdded() Replies if the figure are automatically added into the view when a model object was added in the graph.
boolean	isOutsideGrayed() Replies if the area outside the workspace is grayed.
boolean	isSelectionEnabled() Replies if the selection manager is enabled
boolean	isShadowDrawn() Replies if the shadows are drawn.
Iterator<Figure>	iterator()
int	moveFigureAt(Figure figure, int index) Move the figure at the specified position in the layers used by this panel.
void	moveFigureBackground(Figure figure) Move the figure at the background in the layers used by this panel.
void	moveFigureDown(Figure figure) Move the figure down in the layers used by this panel.
void	moveFigureFront(Figure figure) Move the figure at the front in the layers used by this panel.
void	moveFigureUp(Figure figure) Move the figure up in the layers used by this panel.
protected void	onClick(PointerEvent e)
protected void	onDrawView(Graphics2D canvas, float scaleFactor, CenteringTransform centeringTransform)
protected void	onKeyPressed(KeyEvent e)
protected void	onKeyReleased(KeyEvent e)
protected void	onKeyTyped(KeyEvent e)
protected void	onLongClick(PointerEvent e)
protected void	onPointerDragged(PointerEvent e)
protected void	onPointerMoved(PointerEvent e)
protected void	onPointerPressed(PointerEvent e)
protected void	onPointerReleased(PointerEvent e)
protected void	onUpdateViewParameters()
(package private) void	openPopupEditor(TextFigure figure, Point2D mousePosition) Open the popup editor for the specified figure.
protected void	paintAxis(ZoomableGraphics2D g) Paint the axis.
protected void	paintOutsideGrayed(ZoomableGraphics2D g) Paint the outside of the workspace with gray.
void	paintViewComponents(ViewGraphics2D g) Method to paint the figures.
void	paste() Transfers the contents of the system clipboard into the associated graph.
void	removeAllFigures() Clear the components.
void	removeExceptionListener(ExceptionListener listener) Remove listener on exceptions.
int	removeFigure(Figure component) Remove the specified element.
int	removeFigure(Figure component, boolean unlinkToModelObject) Remove the specified component.
Figure	removeFigureAt(int index) Remove the element at the specified index.
void	removeFigureListener(FigureListener listener) Remove listener on figure events.
void	repaint(Figure figure) Repaint the graphical area around the specified figure.
void	repaint(ModelObject obj) Repaint the graphical area around the figures associated to the specified object.
void	setAxisDrawn(boolean draw) Set if the axis are drawn.
void	setClickPrecision(float precision) Set the precision of the clicks (in pixels).
void	setEditable(boolean editable) Set if this viewer is interactively editable.
void	setFigureAutomaticallyAdded(boolean auto) Replies if the figure are automatically added into the view when a model object was added in the graph.
void	setFigureFactory(FigureFactory<G> factory) Set the figure factory used by this panel.
void	setGraph(G g) set the graph associated to this panel.
void	setOutsideGrayed(boolean gray) Set if the area outside the workspace is grayed.
void	setSelectionManager(boolean enable) Set if the selection manager is enabled
void	setShadowDrawn(boolean draw) Set if the shadows are drawn.

Methods inherited from class org.arakhne.afc.ui.swing.zoom.ZoomableView

fitView, getFocusX, getFocusY, getLOD, getMaxScalingFactor, getMinScalingFactor, getScalingFactor, getScalingFactorToFit, getScalingSensitivity, getScrollingMethod, getViewport, getViewportCenterX, getViewportCenterY, isAntiAliased, isFocusChangedOnMouseWheel, isMouseWheelAllowed, isMoveDirectionInverted, isXAxisInverted, isYAxisInverted, logical2pixel_size, logical2pixel_x, logical2pixel_y, logical2pixel, logical2pixel, logical2pixel, logical2pixel, logical2pixel, logical2pixel, logical2pixel, logical2pixel, onScale, paint, pixel2logical_size, pixel2logical_x, pixel2logical_y, pixel2logical, pixel2logical, pixel2logical, pixel2logical, pixel2logical, pixel2logical, pixel2logical, pixel2logical, print, print, print, printAll, repaint, repaint, repaint, repaint, resetView, setAntiAliased, setFocusChangedOnMouseWheel, setFocusPoint, setMaxScalingFactor, setMinScalingFactor, setMouseWheelEnable, setMoveDirectionInverted, setScalingFactor, setScalingFactorAndFocus, setScalingFactorForPixelRatio, setScalingSensitivity, setScrollingMethod, setXAxisInverted, setYAxisInverted, translateFocusPoint, zoomIn, zoomOut

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.arakhne.neteditor.fig.view.ViewComponentContainer

getTreeLock

Field Detail

CLICK_PRECISION

public static final int CLICK_PRECISION

Precision in pixels for the clicking action (in pixels).

See Also:

Constant Field Values

deletionLock

protected final ReentrantLock deletionLock

Lock resource that may be used for deletion actions.

Constructor Detail

JFigureView

public JFigureView(Class<G> supportedGraphType,
           G g,
           FigureFactory<G> figureFactory,
           boolean isAlwaysRemovingModelObjects)

Construct a new JFigurePanel.

Parameters:

supportedGraphType - is the type supported by this viewer.

g - is the graph to display.

figureFactory - is the factory for figures.

isAlwaysRemovingModelObjects - is true to allow this base mode to remove the model objects each time an associated figure is removed; false to permits to the user to select the figure or the model object to be removed.

Method Detail

isAlwaysRemovingModelObjects

public boolean isAlwaysRemovingModelObjects()

Replies if the mode container want to remove the model objects when a figure is removed from the view.

Returns:

true if both the figure and the model objects should be removed at the same time, false if only the figure should be removed (not the model object).

getSupportedGraphType

public final Class<G> getSupportedGraphType()

Replies the type of graph supported by this viewer.

Returns:

the type of graph supported by this viewer.

getCollisionAvoider

public CollisionAvoider getCollisionAvoider()

Replies the object that permits to avoid collision between a figure to insert inside and the already present figures.

Returns:

the collision avoider.

addFigureListener

public void addFigureListener(FigureListener listener)

Add listener on figure events.

Parameters:

listener -

removeFigureListener

public void removeFigureListener(FigureListener listener)

Remove listener on figure events.

Parameters:

listener -

fireFigureRemoved

protected void fireFigureRemoved(Figure removed)

Notifies the listeners about the removal of a figure.

Parameters:

removed -

fireFigureChanged

protected void fireFigureChanged(Figure changed)

Notifies the listeners about the change of a figure.

Parameters:

changed -

fireFigureAdded

protected void fireFigureAdded(Figure added)

Notifies the listeners about the addition of a figure.

Parameters:

added -

isEditable

public boolean isEditable()

Replies if this viewer is interactively editable.

Returns:

true if this viewer is editable; otherwise false.

isSelectionEnabled

public boolean isSelectionEnabled()

Replies if the selection manager is enabled

Returns:

true if the selection manager is enabled.

setSelectionManager

public void setSelectionManager(boolean enable)

Set if the selection manager is enabled

Parameters:

enable -

setEditable

public void setEditable(boolean editable)

Set if this viewer is interactively editable.

Parameters:

editable - is true if this viewer is editable; otherwise false.

getSelectionBackground

public Color getSelectionBackground()

Replies the background color used for the selection of objects.

Returns:

the selection color.

getSelectionBackgroundColor

public final Color getSelectionBackgroundColor()

Replies the background color associated to selection.

Specified by:

getSelectionBackgroundColor in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the background selection color

getBackgroundColor

public Color getBackgroundColor()

Replies the background color of the panel.

Specified by:

getBackgroundColor in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the background color

getSelectionForeground

public Color getSelectionForeground()

Replies the foreground color used for the selection of objects.

Returns:

the selection color.

getSelectionForegroundColor

public final Color getSelectionForegroundColor()

Replies the foreground color associated to selection.

Specified by:

getSelectionForegroundColor in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the foreground selection color

getHitPrecision

public float getHitPrecision()

Replies the precision of the clicks (in pixels).

Returns:

the precision of the clicks (in pixels).

setClickPrecision

public void setClickPrecision(float precision)

Set the precision of the clicks (in pixels). Byt default, the value of CLICK_PRECISION is used.

Parameters:

precision - is the precision of the clicks, in pixels.

getUUID

public final UUID getUUID()

Relies the id of the view.

Specified by:

getUUID in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the id of the view.

isFigureAutomaticallyAdded

public boolean isFigureAutomaticallyAdded()

Replies if the figure are automatically added into the view when a model object was added in the graph. The figures are created with the figure factory replied by getFigureFactory().

Returns:

true if the figures are automatically added; otherwise false.

setFigureAutomaticallyAdded

public void setFigureAutomaticallyAdded(boolean auto)

Replies if the figure are automatically added into the view when a model object was added in the graph. The figures are created with the figure factory replied by getFigureFactory().

Parameters:

auto - is true if the figures are automatically added; otherwise false.

getFigureFactory

public FigureFactory<G> getFigureFactory()

Replies the figure factory used by this panel.

Specified by:

getFigureFactory in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the figure factory.

setFigureFactory

public void setFigureFactory(FigureFactory<G> factory)

Set the figure factory used by this panel.

Parameters:

factory - is the new figure factory.

getGraph

public G getGraph()

Replies the graph displayed in this viewer.

Returns:

the graph.

setGraph

public void setGraph(G g)

set the graph associated to this panel.

Parameters:

g - is the graph.

iterator

public Iterator<Figure> iterator()

Specified by:

iterator in interface Iterable<Figure>

getFigureCount

public int getFigureCount()

Replies the number of components in this container.

Specified by:

getFigureCount in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the number of components in this container.

getFigureAt

public Figure getFigureAt(int index)

Replies the element at the specified index.

Specified by:

getFigureAt in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Parameters:

index - is the index of the element.

Returns:

the element at the specified index.

addFigure

public int addFigure(Figure component)

Add the element at the specified index.

Specified by:

addFigure in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Parameters:

component - is the component to add.

Returns:

the position where the figure is inserted; or -1 if the figure was not added.

See Also:

importFigure(DecorationFigure), importGraph(String, Graph, Map)

removeFigure

public int removeFigure(Figure component)

Remove the specified element. This function also unlink the model object associated to the figure.

Specified by:

removeFigure in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Parameters:

component - is the component to remove.

Returns:

the position of the removed figure.

See Also:

removeFigure(Figure, boolean)

removeFigure

public int removeFigure(Figure component,
               boolean unlinkToModelObject)

Remove the specified component.

Parameters:

component - is the component to remove.

unlinkToModelObject - indicates if the removed component should be unlink to its model object.

Returns:

position of the removed figure; or -1 if not found.

See Also:

removeFigure(Figure)

removeFigureAt

public Figure removeFigureAt(int index)

Remove the element at the specified index.

Specified by:

removeFigureAt in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Parameters:

index - is the position of the element to remove.

Returns:

the removed figure.

removeAllFigures

public void removeAllFigures()

Clear the components.

Specified by:

removeAllFigures in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

isAxisDrawn

public boolean isAxisDrawn()

Replies if the axis are drawn.

Returns:

true if the axis are drawn; otherwise false.

setAxisDrawn

public void setAxisDrawn(boolean draw)

Set if the axis are drawn.

Parameters:

draw - is true if the axis are drawn; otherwise false.

isOutsideGrayed

public boolean isOutsideGrayed()

Replies if the area outside the workspace is grayed.

Returns:

true if the outside area is grayed; otherwise false.

setOutsideGrayed

public void setOutsideGrayed(boolean gray)

Set if the area outside the workspace is grayed.

Parameters:

gray - is true if the outside area is grayed; otherwise false.

isShadowDrawn

public boolean isShadowDrawn()

Replies if the shadows are drawn.

Specified by:

isShadowDrawn in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

true if the shadows are drawn; otherwise false.

setShadowDrawn

public void setShadowDrawn(boolean draw)

Set if the shadows are drawn.

Specified by:

setShadowDrawn in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Parameters:

draw - is true if the shadows are drawn; otherwise false.

paintViewComponents

public void paintViewComponents(ViewGraphics2D g)

Method to paint the figures.

Specified by:

paintViewComponents in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Parameters:

g - the graphic context.

getPreferredFocusX

protected float getPreferredFocusX()

Specified by:

getPreferredFocusX in class ZoomableView

getPreferredFocusY

protected float getPreferredFocusY()

Specified by:

getPreferredFocusY in class ZoomableView

onDrawView

protected void onDrawView(Graphics2D canvas,
              float scaleFactor,
              CenteringTransform centeringTransform)

Specified by:

onDrawView in class ZoomableView

onClick

protected void onClick(PointerEvent e)

Overrides:

onClick in class ZoomableView

onLongClick

protected void onLongClick(PointerEvent e)

Overrides:

onLongClick in class ZoomableView

onPointerDragged

protected void onPointerDragged(PointerEvent e)

Overrides:

onPointerDragged in class ZoomableView

onPointerMoved

protected void onPointerMoved(PointerEvent e)

Overrides:

onPointerMoved in class ZoomableView

onPointerPressed

protected void onPointerPressed(PointerEvent e)

Overrides:

onPointerPressed in class ZoomableView

onPointerReleased

protected void onPointerReleased(PointerEvent e)

Overrides:

onPointerReleased in class ZoomableView

onKeyPressed

protected void onKeyPressed(KeyEvent e)

Overrides:

onKeyPressed in class ZoomableView

onKeyReleased

protected void onKeyReleased(KeyEvent e)

Overrides:

onKeyReleased in class ZoomableView

onKeyTyped

protected void onKeyTyped(KeyEvent e)

Overrides:

onKeyTyped in class ZoomableView

onUpdateViewParameters

protected void onUpdateViewParameters()

Overrides:

onUpdateViewParameters in class ZoomableView

paintOutsideGrayed

protected void paintOutsideGrayed(ZoomableGraphics2D g)

Paint the outside of the workspace with gray.

Parameters:

g -

paintAxis

protected void paintAxis(ZoomableGraphics2D g)

Paint the axis.

Parameters:

g -

repaint

public void repaint(Figure figure)

Repaint the graphical area around the specified figure. If the specified object is null the entire area is repainted.

Parameters:

figure -

repaint

public void repaint(ModelObject obj)

Repaint the graphical area around the figures associated to the specified object. If the specified object is null the entire area is repainted.

Parameters:

obj -

calcViewBounds

protected Rectangle2f calcViewBounds()

Compute and reply the bounds of the entire document.

Returns:

the bounds of the entire document.

getViewBounds

public final Rectangle2f getViewBounds()

Replies the bounds of the view of the components.

Specified by:

getViewBounds in interface ViewComponentContainer<Figure,G extends Graph<?,?,?,?>>

Returns:

the bounds of the view of the components.

getFigures

public Collection<? extends Figure> getFigures()

Replies the figures in the container.

Returns:

the figures.

getFigureAt

public Figure getFigureAt(float x,
                 float y)

Replies the figure that has the specified point in its shape. If you want to test the point against the bounds of the figures, please use getFigureWithBoundsAt(float, float). This function uses the precision of the clicks, which is replied by getHitPrecision().

Parameters:

x -

y -

Returns:

the hit figure, or null if none.

See Also:

getFigureWithBoundsAt(float, float)

getFigureWithBoundsAt

public Figure getFigureWithBoundsAt(float x,
                           float y)

Replies the figu with the precision re that has its bounds with the specified point inside. If you want to test the point against the shape of the figures, please use getFigureAt(float, float). This function uses the precision of the clicks, which is replied by getHitPrecision().

Parameters:

x -

y -

Returns:

the hit figure, or null if none.

getFiguresOn

public Set<Figure> getFiguresOn(Shape2f bounds)

Replies the figures that are intersecting the specified bounds.

Parameters:

bounds -

Returns:

the hit figures, never null.

getFiguresIn

public Set<Figure> getFiguresIn(Rectangle2f bounds)

Replies the figures that are inside the specified bounds.

Parameters:

bounds -

Returns:

the hit figures, never null.

getFigureOn

public Figure getFigureOn(Shape2f bounds)

Replies the first figure that are intersecting the specified bounds.

Parameters:

bounds -

Returns:

the hit figure, or null.

getFigureIn

public Figure getFigureIn(Rectangle2f bounds)

Replies the first figure that are inside the specified bounds.

Parameters:

bounds -

Returns:

the hit figure, or null.

moveFigureUp

public void moveFigureUp(Figure figure)

Move the figure up in the layers used by this panel.

Parameters:

figure - is the figure to move up.

moveFigureDown

public void moveFigureDown(Figure figure)

Move the figure down in the layers used by this panel.

Parameters:

figure - is the figure to move down.

moveFigureFront

public void moveFigureFront(Figure figure)

Move the figure at the front in the layers used by this panel.

Parameters:

figure - is the figure to move to the front.

moveFigureBackground

public void moveFigureBackground(Figure figure)

Move the figure at the background in the layers used by this panel.

Parameters:

figure - is the figure to move to the background.

moveFigureAt

public int moveFigureAt(Figure figure,
               int index)

Move the figure at the specified position in the layers used by this panel.

Parameters:

figure - is the figure to move to the front.

index - is the new position of the figure.

Returns:

the previous position of the figure; or -1 if the figure was not found.

Throws:

IllegalArgumentException

indexOfFigure

public int indexOfFigure(Figure figure)

Replies the index of the figure. This index is also the position of the from the background.

Parameters:

figure - is the figure to search for.

Returns:

the position of the figure; -1 if is was not found.

importGraph

public Undoable importGraph(String undoLabel,
                   G graph,
                   Map<UUID,List<ViewComponent>> figures)

Import the graph and the specified figures into this editor.

Parameters:

undoLabel - is the label of the undoable edit to reply.

graph - is the graph to integrate.

figures - are the figures (classified per view id) to import, from front to background.

Returns:

the undoable edit that permits to undo the import.

importGraph

public Undoable importGraph(String undoLabel,
                   G graph,
                   List<ViewComponent> figures)

Import the graph and the specified figures into this editor.

Parameters:

undoLabel - is the label of the undoable edit to reply.

graph - is the graph to integrate.

figures - are the figures (classified per view id) to import, from front to background.

Returns:

the undoable edit that permits to undo the import.

importFigure

public Undoable importFigure(DecorationFigure figure)

Import the specified figure into this editor and replies an undoable edit.

Parameters:

figure - is the figure to import.

Returns:

the undoable edit that permits to undo the import.

fireError

public void fireError(Throwable error)

Notifies the listeners about an error that occurs in one of the JFigureEditor components.

Parameters:

error -

addExceptionListener

public void addExceptionListener(ExceptionListener listener)

Add listener on exceptions.

Parameters:

listener -

removeExceptionListener

public void removeExceptionListener(ExceptionListener listener)

Remove listener on exceptions. If there is no listener on exceptions or all the listeners are replying false, the default catching behavior is executed: the exception is forwaded to the VM.

Parameters:

listener -

getSelectionManager

public JSelectionManager getSelectionManager()

Replies the selection manager.

Returns:

the selection manager.

getUndoManager

public UndoManagerSwing getUndoManager()

Replies the manager of undoable actions.

Returns:

the undo manager.

getModeManager

public ActionModeManager getModeManager()

Replies the action mode manager used by this viewser.

Returns:

the manager.

cut

public void cut()

Transfers the currently selected figures to the system clipboard, removing the contents from the model. The current selection is reset. Does nothing for null selections.

copy

public void copy()

Transfers the currently selected figures to the system clipboard, leaving the contents in the text model. The current selection remains intact. Does nothing for null selections.

paste

public void paste()

Transfers the contents of the system clipboard into the associated graph. If the clipboard is empty, does nothing.

openPopupEditor

void openPopupEditor(TextFigure figure,
                   Point2D mousePosition)

Open the popup editor for the specified figure.

Parameters:

figure -

mousePosition - is the position of the mouse when opening the editor; may be null if the mouse position is unknown.

closePopupEditor

void closePopupEditor()

Cancel and close the popup editor.