Package com.bc.ceres.swing.figure.support

Class DefaultFigureEditor

java.lang.Object

com.bc.ceres.core.ExtensibleObject

com.bc.ceres.swing.figure.support.DefaultFigureEditor

All Implemented Interfaces:

Extensible, ViewportAware, FigureEditor, InteractorAware, SelectionChangeEmitter, SelectionContext, SelectionSource

public class DefaultFigureEditor
extends ExtensibleObject
implements FigureEditor

A default implementation of a figure editor.

Since:

Ceres 0.10

Constructor Summary

Constructors

Constructor	Description
DefaultFigureEditor(JComponent editorComponent)
DefaultFigureEditor(JComponent editorComponent, Viewport viewport, UndoContext undoContext, FigureCollection figureCollection, FigureFactory figureFactory)

Method Summary

Modifier and Type	Method	Description
void	addSelectionChangeListener(SelectionChangeListener listener)	Adds a selection change listener to this emitter.
boolean	canDeleteSelection()
boolean	canInsert(Transferable contents)	Tests whether the current contents (e.g.
boolean	canSelectAll()
void	changeFigure(Figure figure, Object figureMemento, String presentationName)
void	deleteFigures(boolean performDelete, Figure... figures)
void	deleteSelection()	Deletes the current selection.
void	draw(Rendering rendering)	Calls
void	drawFigureCollection(Rendering rendering)
void	drawFigureSelection(Rendering rendering)
void	drawSelectionRectangle(Rendering rendering)
FigureStyle	getDefaultLineStyle()
FigureStyle	getDefaultPolygonStyle()
JComponent	getEditorComponent()
FigureCollection	getFigureCollection()
FigureFactory	getFigureFactory()
FigureSelection	getFigureSelection()
Interactor	getInteractor()
Selection	getSelection()
SelectionChangeListener[]	getSelectionChangeListeners()	Gets all registered selection change listeners.
SelectionContext	getSelectionContext()
Rectangle	getSelectionRectangle()
UndoContext	getUndoContext()
Viewport	getViewport()
void	insert(Transferable contents)	Inserts a selection represented by the given Transferable into this context.
void	insertFigures(boolean performInsert, Figure... figures)
void	removeSelectionChangeListener(SelectionChangeListener listener)	Removes a selection change listener from this emitter.
void	selectAll()	Selects all items.
void	setDefaultLineStyle(FigureStyle defaultLineStyle)
void	setDefaultPolygonStyle(FigureStyle defaultPolygonStyle)
void	setFigureCollection(FigureCollection figureCollection)
void	setFigureFactory(FigureFactory figureFactory)
void	setInteractor(Interactor interactor)
void	setSelection(Selection selection)	Sets a new selection.
void	setSelectionRectangle(Rectangle newRect)

Methods inherited from class com.bc.ceres.core.ExtensibleObject

getExtension

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bc.ceres.core.Extensible

getExtension

Constructor Detail

DefaultFigureEditor

public DefaultFigureEditor(JComponent editorComponent)

DefaultFigureEditor

public DefaultFigureEditor(JComponent editorComponent,
                           Viewport viewport,
                           UndoContext undoContext,
                           FigureCollection figureCollection,
                           FigureFactory figureFactory)

Method Detail

getUndoContext

public UndoContext getUndoContext()

Specified by:

getUndoContext in interface FigureEditor

getEditorComponent

public JComponent getEditorComponent()

Specified by:

getEditorComponent in interface FigureEditor

insertFigures

public void insertFigures(boolean performInsert,
                          Figure... figures)

Specified by:

insertFigures in interface FigureEditor

deleteFigures

public void deleteFigures(boolean performDelete,
                          Figure... figures)

Specified by:

deleteFigures in interface FigureEditor

changeFigure

public void changeFigure(Figure figure,
                         Object figureMemento,
                         String presentationName)

Specified by:

changeFigure in interface FigureEditor

getSelectionContext

public SelectionContext getSelectionContext()

Specified by:

getSelectionContext in interface FigureEditor

getSelectionRectangle

public Rectangle getSelectionRectangle()

Specified by:

getSelectionRectangle in interface FigureEditor

setSelectionRectangle

public void setSelectionRectangle(Rectangle newRect)

Specified by:

setSelectionRectangle in interface FigureEditor

getFigureCollection

public FigureCollection getFigureCollection()

Specified by:

getFigureCollection in interface FigureEditor

setFigureCollection

public void setFigureCollection(FigureCollection figureCollection)

getFigureSelection

public FigureSelection getFigureSelection()

Specified by:

getFigureSelection in interface FigureEditor

getFigureFactory

public FigureFactory getFigureFactory()

Specified by:

getFigureFactory in interface FigureEditor

setFigureFactory

public void setFigureFactory(FigureFactory figureFactory)

getSelection

public Selection getSelection()

Specified by:

getSelection in interface SelectionSource

Returns:

The current selection. The selection may be empty, but never null.

See Also:

Selection.EMPTY, Selection.isEmpty()

setSelection

public void setSelection(Selection selection)

Description copied from interface: SelectionContext

Sets a new selection.

Specified by:

setSelection in interface SelectionContext

Parameters:

selection - The new selection.

addSelectionChangeListener

public void addSelectionChangeListener(SelectionChangeListener listener)

Description copied from interface: SelectionChangeEmitter

Adds a selection change listener to this emitter.

Specified by:

addSelectionChangeListener in interface SelectionChangeEmitter

Parameters:

listener - The listener.

removeSelectionChangeListener

public void removeSelectionChangeListener(SelectionChangeListener listener)

Description copied from interface: SelectionChangeEmitter

Removes a selection change listener from this emitter.

Specified by:

removeSelectionChangeListener in interface SelectionChangeEmitter

Parameters:

listener - The listener.

getSelectionChangeListeners

public SelectionChangeListener[] getSelectionChangeListeners()

Description copied from interface: SelectionChangeEmitter

Gets all registered selection change listeners.

Specified by:

getSelectionChangeListeners in interface SelectionChangeEmitter

Returns:

An array containing all registered listeners.

insert

public void insert(Transferable contents)
            throws IOException,
                   UnsupportedFlavorException

Description copied from interface: SelectionContext

Inserts a selection represented by the given Transferable into this context.

Specified by:

insert in interface SelectionContext

Parameters:

contents - The transferable object.

Throws:

IOException - if an I/O error occurs

UnsupportedFlavorException

See Also:

SelectionContext.canInsert(java.awt.datatransfer.Transferable), Selection.createTransferable(boolean), ClipboardOwner.lostOwnership(java.awt.datatransfer.Clipboard, java.awt.datatransfer.Transferable)

canDeleteSelection

public boolean canDeleteSelection()

Specified by:

canDeleteSelection in interface SelectionContext

Returns:

true if the current selection can be deleted.

See Also:

SelectionContext.deleteSelection()

deleteSelection

public void deleteSelection()

Description copied from interface: SelectionContext

Deletes the current selection.

Specified by:

deleteSelection in interface SelectionContext

See Also:

SelectionContext.canDeleteSelection()

canInsert

public boolean canInsert(Transferable contents)

Description copied from interface: SelectionContext

Tests whether the current contents (e.g. from clipboard, drag and drop) can be inserted into this selection context.

Specified by:

canInsert in interface SelectionContext

Parameters:

contents - The contents.

Returns:

true if the given contents can be inserted into this context.

See Also:

SelectionContext.insert(Transferable)

selectAll

public void selectAll()

Description copied from interface: SelectionContext

Selects all items.

Specified by:

selectAll in interface SelectionContext

See Also:

SelectionContext.canSelectAll()

canSelectAll

public boolean canSelectAll()

Specified by:

canSelectAll in interface SelectionContext

Returns:

true if all items can be selected.

See Also:

SelectionContext.selectAll()

getInteractor

public Interactor getInteractor()

Specified by:

getInteractor in interface InteractorAware

setInteractor

public void setInteractor(Interactor interactor)

Specified by:

setInteractor in interface FigureEditor

getViewport

public Viewport getViewport()

Specified by:

getViewport in interface ViewportAware

Returns:

The viewport.

getDefaultLineStyle

public FigureStyle getDefaultLineStyle()

Specified by:

getDefaultLineStyle in interface FigureEditor

setDefaultLineStyle

public void setDefaultLineStyle(FigureStyle defaultLineStyle)

getDefaultPolygonStyle

public FigureStyle getDefaultPolygonStyle()

Specified by:

getDefaultPolygonStyle in interface FigureEditor

setDefaultPolygonStyle

public void setDefaultPolygonStyle(FigureStyle defaultPolygonStyle)

draw

public void draw(Rendering rendering)

Calls

 drawFigureCollection(rendering);
 drawFigureSelection(rendering);
 drawSelectionRectangle(rendering);
 

Parameters:

rendering - The rendering.

drawFigureCollection

public void drawFigureCollection(Rendering rendering)

drawFigureSelection

public void drawFigureSelection(Rendering rendering)

drawSelectionRectangle

public void drawSelectionRectangle(Rendering rendering)