net.sourceforge.plantuml.sequencediagram.graphic.SequenceDiagramArea Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-gplv2 Show documentation
Show all versions of plantuml-gplv2 Show documentation
PlantUML is a component that allows to quickly write diagrams from text.
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.sequencediagram.graphic;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.png.PngTitler;
import net.sourceforge.plantuml.utils.MathUtils;
public class SequenceDiagramArea {
private final double sequenceWidth;
private final double sequenceHeight;
private double headerWidth;
private double headerHeight;
private double headerMargin;
private double titleWidth;
private double titleHeight;
private double captionWidth;
private double captionHeight;
private double footerWidth;
private double footerHeight;
private double footerMargin;
private double legendWidth;
private double legendHeight;
private boolean isLegendTop;
private HorizontalAlignment legendHorizontalAlignment;
public void setLegend(XDimension2D dimLegend, boolean isLegendTop, HorizontalAlignment horizontalAlignment) {
this.legendHorizontalAlignment = horizontalAlignment;
this.legendWidth = dimLegend.getWidth();
this.legendHeight = dimLegend.getHeight();
this.isLegendTop = isLegendTop;
}
public double getLegendWidth() {
return legendWidth;
}
public boolean hasLegend() {
return legendHeight > 0 && legendWidth > 0;
}
public double getLegendX() {
if (legendHorizontalAlignment == HorizontalAlignment.LEFT)
return 0;
else if (legendHorizontalAlignment == HorizontalAlignment.RIGHT)
return Math.max(0, getWidth() - legendWidth);
else
return Math.max(0, getWidth() - legendWidth) / 2;
}
public SequenceDiagramArea(double width, double height) {
this.sequenceWidth = width;
this.sequenceHeight = height;
}
public void setTitleArea(double width, double height) {
this.titleWidth = width;
this.titleHeight = height;
}
private void setCaptionArea(double width, double height) {
this.captionWidth = width;
this.captionHeight = height;
}
public void setCaptionArea(XDimension2D dim) {
setCaptionArea(dim.getWidth(), dim.getHeight());
}
public void setHeaderArea(double headerWidth, double headerHeight, double headerMargin) {
this.headerWidth = headerWidth;
this.headerHeight = headerHeight;
this.headerMargin = headerMargin;
}
public void setFooterArea(double footerWidth, double footerHeight, double footerMargin) {
this.footerWidth = footerWidth;
this.footerHeight = footerHeight;
this.footerMargin = footerMargin;
}
public double getWidth() {
return MathUtils.max(sequenceWidth, headerWidth, titleWidth, footerWidth, captionWidth);
}
public double getHeight() {
return sequenceHeight + headerHeight + headerMargin + titleHeight + footerMargin + footerHeight + captionHeight
+ legendHeight;
}
public double getFooterY() {
return sequenceHeight + headerHeight + headerMargin + titleHeight + footerMargin + captionHeight + legendHeight;
}
public double getCaptionY() {
return sequenceHeight + headerHeight + headerMargin + titleHeight + legendHeight;
}
public double getLegendY() {
if (isLegendTop)
return titleHeight + headerHeight + headerMargin;
return sequenceHeight + headerHeight + headerMargin + titleHeight;
}
public double getTitleX() {
return (getWidth() - titleWidth) / 2;
}
public double getTitleY() {
return headerHeight + headerMargin;
}
public double getHeaderHeightMargin() {
return headerHeight + headerMargin;
}
public double getCaptionX() {
return (getWidth() - captionWidth) / 2;
}
public double getSequenceAreaX() {
return (getWidth() - sequenceWidth) / 2;
}
public double getSequenceAreaY() {
if (isLegendTop)
return getTitleY() + titleHeight + legendHeight;
return getTitleY() + titleHeight;
}
public double getHeaderY() {
return 0;
}
public double getFooterX(HorizontalAlignment align) {
if (align == HorizontalAlignment.LEFT)
return 0;
if (align == HorizontalAlignment.RIGHT)
return getWidth() - footerWidth;
if (align == HorizontalAlignment.CENTER)
return (getWidth() - footerWidth) / 2;
throw new IllegalStateException();
}
public double getHeaderX(HorizontalAlignment align) {
if (align == HorizontalAlignment.LEFT)
return 0;
if (align == HorizontalAlignment.RIGHT)
return getWidth() - headerWidth;
if (align == HorizontalAlignment.CENTER)
return (getWidth() - headerWidth) / 2;
throw new IllegalStateException();
}
public void initFooter(PngTitler pngTitler, StringBounder stringBounder) {
final XDimension2D dim = pngTitler.getTextDimension(stringBounder);
if (dim != null)
setFooterArea(dim.getWidth(), dim.getHeight(), 0);
}
public void initHeader(PngTitler pngTitler, StringBounder stringBounder) {
final XDimension2D dim = pngTitler.getTextDimension(stringBounder);
if (dim != null)
setHeaderArea(dim.getWidth(), dim.getHeight(), 0);
}
}