org.arakhne.neteditor.figlayout.basic

Class BasicGridBagFigureLayout

java.lang.Object

org.arakhne.neteditor.figlayout.AbstractFigureLayout

org.arakhne.neteditor.figlayout.AbstractDirectionBasedFigureLayout

org.arakhne.neteditor.figlayout.basic.BasicGridBagFigureLayout

All Implemented Interfaces:

ViewComponentConstants, FigureLayout, FigureLayoutConstants

public class BasicGridBagFigureLayout
extends AbstractDirectionBasedFigureLayout

Laying out figures on a grid. This laying out algorithm assumes that all the given nodes are decorations.

Version:

NetEditor Figure Layout $Revision$ 2013-10-23 21:06:25

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.neteditor

Maven Artifact Id:

neteditor-figlayout

Field Summary

Fields inherited from interface org.arakhne.neteditor.figlayout.FigureLayoutConstants

HALF_MINIMAL_HORIZONTAL_PADDING, HALF_MINIMAL_VERTICAL_PADDING

Fields inherited from interface org.arakhne.neteditor.fig.view.ViewComponentConstants

DEFAULT_ACTIVE_COLOR, DEFAULT_BACKGROUND_SELECTION_COLOR, DEFAULT_DAMAGING_EXTENTS, DEFAULT_DRAW_SHADOW, DEFAULT_FILL_COLOR, DEFAULT_FOREGROUND_SELECTION_COLOR, DEFAULT_LINE_COLOR, DEFAULT_LOCKING_FILL_COLOR, DEFAULT_LOCKING_OUTLINE_COLOR, DEFAULT_MAXIMAL_SIZE, DEFAULT_MINIMAL_SIZE, DEFAULT_MINIMAL_SUBFIGURE_SIZE, DEFAULT_SHADOW_PROJECTION_DISTANCE_X, DEFAULT_SHADOW_PROJECTION_DISTANCE_Y, FLATTENING_PRECISION

Constructor Summary

Constructors

Constructor and Description
BasicGridBagFigureLayout()

Method Summary

Methods

Modifier and Type	Method and Description
Undoable	layoutFigures(Collection<? extends Figure> figures) Run the laying-out algorithm for the given figures.

Methods inherited from class org.arakhne.neteditor.figlayout.AbstractDirectionBasedFigureLayout

getLayoutDirection, setLayoutDirection

Methods inherited from class org.arakhne.neteditor.figlayout.AbstractFigureLayout

getMargins, getOrigin, setMargins, setOrigin, setOrigin

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicGridBagFigureLayout

public BasicGridBagFigureLayout()

Method Detail

layoutFigures

public Undoable layoutFigures(Collection<? extends Figure> figures)

Run the laying-out algorithm for the given figures.

Parameters:

figures - are the figures to laying out.

Returns:

the undoable edit that permits to revert the laying out; or null if the layout does not supports the undo/redo feature or it has nothing to undo.