NShape Reference
LayouterBase Class

<< Click to Display Table of Contents >>

Navigation:  Class Reference > Namespace Dataweb.NShape.Layouters >

NShape Reference
LayouterBase Class

Previous pageReturn to chapter overviewNext page

Abstract base class for layouters. Implementations of the ILayouter interface can but need not derive from this class.

Syntax

public abstract class LayouterBase

Description

Abstract base class for layouters. Implementations of the ILayouter interface can but need not derive from this class.

Public Properties

Name

Description

AllShapes

A list of all shapes of the diagram.

Description

Description of the layouter.

InvariantName

Invariant name of the layouter.

Shapes

A list of shapes to layout.

Public Methods

Name

Description

Execute

Executes the layouting operation.

ExecuteStep

Executes one step of the layouting operation.

Fit

Fits all layouted shapes within the given rectangle without destroying the layout.

Prepare

Prepares for layouting.

RestoreState

Restores the state of the layouting process.

SaveState

Internally saves the state of the layouting process.

Unprepare

Resets the layouter to the state before the preparation.

Protected Properties and Fields

Name

Description

allShapes

The internal list of all shapes of the diagram.

layoutArea

The layout area.

project

The current project.

selectedPositions

Initial positions of the selected shapes.

selectedShapes

The selected shapes to layout.

Protected Methods

Name

Description

CalcLayoutArea

Calculates the area the shapes are layouted within.

Constructor

Constructs a new instance.

Derived Classes

Derived classes are:

ExpansionLayouter

GridLayouter

FlowLayouter

RepulsionLayouter

Requirements

Namespace: Dataweb.NShape.Layouters

Assembly: Dataweb.NShape