Package com.powsybl.sld.layout

Class LayoutParameters

java.lang.Object

com.powsybl.sld.layout.LayoutParameters

public class LayoutParameters
extends Object

Author:

Benoit Jeanson , Nicolas Duchene, Geoffroy Jamgotchian , Franck Lecuyer , Jacques Borsenberger

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LayoutParameters.CssLocation
static class	LayoutParameters.Padding

Constructor Summary

Constructors

Constructor	Description
LayoutParameters()
LayoutParameters(LayoutParameters other)
LayoutParameters(LayoutParameters.Padding voltageLevelPadding, LayoutParameters.Padding diagramPadding, double verticalSpaceBus, double horizontalBusPadding, double cellWidth, double externCellHeight, double internCellHeight, double stackHeight, boolean showGrid, boolean tooltipEnabled, boolean showInternalNodes, double scaleFactor, boolean drawStraightWires, double horizontalSnakeLinePadding, double verticalSnakeLinePadding, double arrowDistance, double minSpaceForFeederArrows, String diagramName, boolean avoidSVGComponentsDuplication, boolean adaptCellHeightToContent, double maxComponentHeight, double minSpaceBetweenComponents, double minExternCellHeight, boolean labelCentered, boolean labelDiagonal, double angleLabelShift, boolean highlightLineState, boolean addNodesInfos, boolean feederArrowSymmetry, LayoutParameters.CssLocation cssLocation, boolean svgWidthAndHeightAdded)

Method Summary

Modifier and Type	Method	Description
double	getAngleLabelShift()
double	getArrowDistance()
double	getBusPadding()
double	getCellWidth()
Map<String,ComponentSize>	getComponentsSize()
LayoutParameters.CssLocation	getCssLocation()
String	getDiagramName()
LayoutParameters.Padding	getDiagramPadding()
double	getExternCellHeight()
double	getHorizontalBusPadding()
double	getHorizontalSnakeLinePadding()
double	getInternCellHeight()
double	getMaxComponentHeight()
double	getMinExternCellHeight()
double	getMinSpaceBetweenComponents()
double	getMinSpaceForFeederArrows()
double	getScaleFactor()
double	getStackHeight()
double	getVerticalSnakeLinePadding()
double	getVerticalSpaceBus()
LayoutParameters.Padding	getVoltageLevelPadding()
boolean	isAdaptCellHeightToContent()
boolean	isAddNodesInfos()
boolean	isAvoidSVGComponentsDuplication()
boolean	isDrawStraightWires()
boolean	isFeederArrowSymmetry()
boolean	isHighlightLineState()
boolean	isLabelCentered()
boolean	isLabelDiagonal()
boolean	isShowGrid()
boolean	isShowInternalNodes()
boolean	isSvgWidthAndHeightAdded()
boolean	isTooltipEnabled()
LayoutParameters	setAdaptCellHeightToContent(boolean adaptCellHeightToContent)
LayoutParameters	setAddNodesInfos(boolean addNodesInfos)
LayoutParameters	setAngleLabelShift(double angleLabelShift)
LayoutParameters	setArrowDistance(double arrowDistance)
LayoutParameters	setAvoidSVGComponentsDuplication(boolean avoidSVGComponentsDuplication)
LayoutParameters	setCellWidth(double cellWidth)
void	setComponentsSize(Map<String,ComponentSize> componentsSize)
LayoutParameters	setCssLocation(LayoutParameters.CssLocation cssLocation)
LayoutParameters	setDiagrammPadding(double paddingLeft, double paddingTop, double paddingRight, double paddingBottom)
LayoutParameters	setDiagramName(String diagramName)
LayoutParameters	setDrawStraightWires(boolean drawStraightWires)
LayoutParameters	setExternCellHeight(double externCellHeight)
LayoutParameters	setFeederArrowSymmetry(boolean feederArrowSymmetry)
LayoutParameters	setHighlightLineState(boolean highlightLineState)
LayoutParameters	setHorizontalBusPadding(double horizontalSpaceBus)
LayoutParameters	setHorizontalSnakeLinePadding(double horizontalSnakeLinePadding)
LayoutParameters	setInternCellHeight(double internCellHeight)
LayoutParameters	setLabelCentered(boolean labelCentered)
LayoutParameters	setLabelDiagonal(boolean labelDiagonal)
LayoutParameters	setMaxComponentHeight(double maxComponentHeight)
LayoutParameters	setMinExternCellHeight(double minExternCellHeight)
LayoutParameters	setMinSpaceBetweenComponents(double minSpaceBetweenComponents)
LayoutParameters	setMinSpaceForFeederArrows(double minSpaceForFeederArrows)
LayoutParameters	setScaleFactor(double scaleFactor)
LayoutParameters	setShowGrid(boolean showGrid)
LayoutParameters	setShowInternalNodes(boolean showInternalNodes)
LayoutParameters	setStackHeight(double stackHeight)
LayoutParameters	setSvgWidthAndHeightAdded(boolean svgWidthAndHeightAdded)
LayoutParameters	setTooltipEnabled(boolean tooltipEnabled)
LayoutParameters	setVerticalSnakeLinePadding(double verticalSnakeLinePadding)
LayoutParameters	setVerticalSpaceBus(double verticalSpaceBus)
LayoutParameters	setVoltageLevelPadding(double paddingLeft, double paddingTop, double paddingRight, double paddingBottom)

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutParameters

public LayoutParameters()

LayoutParameters

public LayoutParameters(LayoutParameters.Padding voltageLevelPadding,
                        LayoutParameters.Padding diagramPadding,
                        double verticalSpaceBus,
                        double horizontalBusPadding,
                        double cellWidth,
                        double externCellHeight,
                        double internCellHeight,
                        double stackHeight,
                        boolean showGrid,
                        boolean tooltipEnabled,
                        boolean showInternalNodes,
                        double scaleFactor,
                        boolean drawStraightWires,
                        double horizontalSnakeLinePadding,
                        double verticalSnakeLinePadding,
                        double arrowDistance,
                        double minSpaceForFeederArrows,
                        String diagramName,
                        boolean avoidSVGComponentsDuplication,
                        boolean adaptCellHeightToContent,
                        double maxComponentHeight,
                        double minSpaceBetweenComponents,
                        double minExternCellHeight,
                        boolean labelCentered,
                        boolean labelDiagonal,
                        double angleLabelShift,
                        boolean highlightLineState,
                        boolean addNodesInfos,
                        boolean feederArrowSymmetry,
                        LayoutParameters.CssLocation cssLocation,
                        boolean svgWidthAndHeightAdded)

LayoutParameters

public LayoutParameters(LayoutParameters other)

Method Detail

getVerticalSpaceBus

public double getVerticalSpaceBus()

setVerticalSpaceBus

public LayoutParameters setVerticalSpaceBus(double verticalSpaceBus)

getHorizontalBusPadding

public double getHorizontalBusPadding()

setHorizontalBusPadding

public LayoutParameters setHorizontalBusPadding(double horizontalSpaceBus)

getCellWidth

public double getCellWidth()

setCellWidth

public LayoutParameters setCellWidth(double cellWidth)

getExternCellHeight

public double getExternCellHeight()

setExternCellHeight

public LayoutParameters setExternCellHeight(double externCellHeight)

getInternCellHeight

public double getInternCellHeight()

setInternCellHeight

public LayoutParameters setInternCellHeight(double internCellHeight)

getStackHeight

public double getStackHeight()

setStackHeight

public LayoutParameters setStackHeight(double stackHeight)

isShowGrid

public boolean isShowGrid()

setShowGrid

public LayoutParameters setShowGrid(boolean showGrid)

isShowInternalNodes

public boolean isShowInternalNodes()

setShowInternalNodes

public LayoutParameters setShowInternalNodes(boolean showInternalNodes)

getScaleFactor

public double getScaleFactor()

setScaleFactor

public LayoutParameters setScaleFactor(double scaleFactor)

getDiagramName

public String getDiagramName()

setDiagramName

public LayoutParameters setDiagramName(String diagramName)

isDrawStraightWires

public boolean isDrawStraightWires()

setDrawStraightWires

public LayoutParameters setDrawStraightWires(boolean drawStraightWires)

getHorizontalSnakeLinePadding

public double getHorizontalSnakeLinePadding()

setHorizontalSnakeLinePadding

public LayoutParameters setHorizontalSnakeLinePadding(double horizontalSnakeLinePadding)

getVerticalSnakeLinePadding

public double getVerticalSnakeLinePadding()

setVerticalSnakeLinePadding

public LayoutParameters setVerticalSnakeLinePadding(double verticalSnakeLinePadding)

getArrowDistance

public double getArrowDistance()

setArrowDistance

public LayoutParameters setArrowDistance(double arrowDistance)

isAvoidSVGComponentsDuplication

public boolean isAvoidSVGComponentsDuplication()

setAvoidSVGComponentsDuplication

public LayoutParameters setAvoidSVGComponentsDuplication(boolean avoidSVGComponentsDuplication)

isAdaptCellHeightToContent

public boolean isAdaptCellHeightToContent()

setAdaptCellHeightToContent

public LayoutParameters setAdaptCellHeightToContent(boolean adaptCellHeightToContent)

getMaxComponentHeight

public double getMaxComponentHeight()

setMaxComponentHeight

public LayoutParameters setMaxComponentHeight(double maxComponentHeight)

getMinSpaceBetweenComponents

public double getMinSpaceBetweenComponents()

setMinSpaceBetweenComponents

public LayoutParameters setMinSpaceBetweenComponents(double minSpaceBetweenComponents)

getMinExternCellHeight

public double getMinExternCellHeight()

setMinExternCellHeight

public LayoutParameters setMinExternCellHeight(double minExternCellHeight)

setComponentsSize

public void setComponentsSize(Map<String,ComponentSize> componentsSize)

getComponentsSize

public Map<String,ComponentSize> getComponentsSize()

getAngleLabelShift

public double getAngleLabelShift()

setAngleLabelShift

public LayoutParameters setAngleLabelShift(double angleLabelShift)

isLabelCentered

public boolean isLabelCentered()

setLabelCentered

public LayoutParameters setLabelCentered(boolean labelCentered)

isLabelDiagonal

public boolean isLabelDiagonal()

setLabelDiagonal

public LayoutParameters setLabelDiagonal(boolean labelDiagonal)

isHighlightLineState

public boolean isHighlightLineState()

setHighlightLineState

public LayoutParameters setHighlightLineState(boolean highlightLineState)

isTooltipEnabled

public boolean isTooltipEnabled()

setTooltipEnabled

public LayoutParameters setTooltipEnabled(boolean tooltipEnabled)

isAddNodesInfos

public boolean isAddNodesInfos()

setAddNodesInfos

public LayoutParameters setAddNodesInfos(boolean addNodesInfos)

getMinSpaceForFeederArrows

public double getMinSpaceForFeederArrows()

setMinSpaceForFeederArrows

public LayoutParameters setMinSpaceForFeederArrows(double minSpaceForFeederArrows)

isFeederArrowSymmetry

public boolean isFeederArrowSymmetry()

setFeederArrowSymmetry

public LayoutParameters setFeederArrowSymmetry(boolean feederArrowSymmetry)

getCssLocation

public LayoutParameters.CssLocation getCssLocation()

setCssLocation

public LayoutParameters setCssLocation(LayoutParameters.CssLocation cssLocation)

getVoltageLevelPadding

public LayoutParameters.Padding getVoltageLevelPadding()

setVoltageLevelPadding

public LayoutParameters setVoltageLevelPadding(double paddingLeft,
                                               double paddingTop,
                                               double paddingRight,
                                               double paddingBottom)

getDiagramPadding

public LayoutParameters.Padding getDiagramPadding()

setDiagrammPadding

public LayoutParameters setDiagrammPadding(double paddingLeft,
                                           double paddingTop,
                                           double paddingRight,
                                           double paddingBottom)

isSvgWidthAndHeightAdded

public boolean isSvgWidthAndHeightAdded()

setSvgWidthAndHeightAdded

public LayoutParameters setSvgWidthAndHeightAdded(boolean svgWidthAndHeightAdded)

getBusPadding

public double getBusPadding()