Package com.bc.ceres.swing.figure

Interface FigureSelection

All Superinterfaces:

ClipboardOwner, Cloneable, Extensible, Figure, FigureCollection, Restorable, Selection

All Known Implementing Classes:

DefaultFigureSelection

public interface FigureSelection
extends FigureCollection, Selection

A selection of figures.

Figures added to this collection will automatically be selected. When removed, they become deselected.

A figure selection can have a certain selection stage. When displayed, a figure selections asks its figures for its Handles at the given stage.

Since:

Ceres 0.10

Nested Class Summary

Nested classes/interfaces inherited from interface com.bc.ceres.swing.figure.Figure

Figure.Rank

Field Summary

Fields inherited from interface com.bc.ceres.swing.selection.Selection

EMPTY

Method Summary

Modifier and Type	Method	Description
Handle[]	getHandles()	Gets the handles associated with the current selection stage.
Handle	getSelectedHandle()
int	getSelectionStage()	Gets the current selection stage.
void	setSelectedHandle(Handle handle)
void	setSelectionStage(int stage)	Sets the current selection stage.

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

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

getExtension

Methods inherited from interface com.bc.ceres.swing.figure.Figure

addChangeListener, addFigure, addFigure, addFigures, addSegment, clone, contains, createHandles, dispose, draw, getBounds, getChangeListeners, getEffectiveStyle, getFigure, getFigure, getFigureCount, getFigureIndex, getFigures, getFigures, getMaxSelectionStage, getNormalStyle, getRank, getSegment, getSelectedStyle, isCloseTo, isCollection, isSelectable, isSelected, move, removeAllFigures, removeChangeListener, removeFigure, removeFigures, removeSegment, rotate, scale, setNormalStyle, setSegment, setSelected, setSelectedStyle

Methods inherited from interface com.bc.ceres.swing.undo.Restorable

createMemento, setMemento

Methods inherited from interface com.bc.ceres.swing.selection.Selection

clone, createTransferable, getPresentationName, getSelectedValue, getSelectedValues, isEmpty

Method Details

getSelectionStage

int getSelectionStage()

Gets the current selection stage. The maximum selection stage is given by the selected figure(s).

Returns:

The current selection stage.

See Also:

• Figure.getMaxSelectionStage()
• Figure.createHandles(int)

setSelectionStage

void setSelectionStage(int stage)

Sets the current selection stage. The maximum selection stage is given by the selected figure(s).

Parameters:

stage - The current selection stage.

getHandles

Handle[] getHandles()

Gets the handles associated with the current selection stage.

1. For a single selection, the handles are the ones created by the selected figure's Figure.createHandles(int) factory method.
2. For a multiple selection, the handles are the ones created by this figure selection's Figure.createHandles(int) factory method.
3. If the selection is empty, an empty handle array is returned.

Returns:

The handles associated with the current selection stage.

See Also:

• getSelectionStage()

getSelectedHandle

Handle getSelectedHandle()

setSelectedHandle

void setSelectedHandle(Handle handle)