net.sourceforge.plantuml.TitledDiagram Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-lgpl Show documentation
Show all versions of plantuml-lgpl 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 Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* PlantUML distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library. If not, see orig) {
super(source);
this.type = type;
this.skinParam = SkinParam.create(type);
if (orig != null)
this.skinParam.copyAllFrom(orig);
}
public final StyleBuilder getCurrentStyleBuilder() {
return skinParam.getCurrentStyleBuilder();
}
final public UmlDiagramType getUmlDiagramType() {
return type;
}
public final ISkinParam getSkinParam() {
return skinParam;
}
public void setParam(String key, String value) {
skinParam.setParam(StringUtils.goLowerCase(key), value);
}
public void addSprite(String name, Sprite sprite) {
skinParam.addSprite(name, sprite);
}
public CommandExecutionResult loadSkin(String newSkin) throws IOException {
final String filename = newSkin + ".skin";
final InputStream is = StyleLoader.getInputStreamForStyle(filename);
if (is == null)
return CommandExecutionResult.error("Cannot find style " + newSkin);
is.close();
getSkinParam().setDefaultSkin(filename);
return CommandExecutionResult.ok();
}
final public void setTitle(DisplayPositioned title) {
if (title.isNull() || title.getDisplay().isWhite())
return;
this.title = title;
}
@Override
final public DisplayPositionned getTitle() {
return title;
}
@Override
@ApiStable
final public Display getTitleDisplay() {
if (title == null)
return Display.NULL;
return title.getDisplay();
}
final public void setMainFrame(Display mainFrame) {
this.mainFrame = mainFrame;
}
final public void setCaption(DisplayPositioned caption) {
this.caption = caption;
}
final public DisplayPositioned getCaption() {
return caption;
}
final public DisplaySection getHeader() {
return header;
}
final public DisplaySection getFooter() {
return footer;
}
final public DisplayPositioned getLegend() {
return legend;
}
public void setLegend(DisplayPositioned legend) {
this.legend = legend;
}
final public Display getMainFrame() {
return mainFrame;
}
private boolean useSmetana;
private boolean useElk;
public void setUseSmetana(boolean useSmetana) {
this.useSmetana = useSmetana;
}
public void setUseElk(boolean useElk) {
this.useElk = useElk;
}
public boolean isUseElk() {
if (FORCE_ELK)
return true;
return this.useElk;
}
public boolean isUseSmetana() {
if (FORCE_SMETANA)
return true;
return useSmetana;
// return true;
}
@Override
public ClockwiseTopRightBottomLeft getDefaultMargins() {
return ClockwiseTopRightBottomLeft.same(10);
}
@Override
public ImageBuilder createImageBuilder(FileFormatOption fileFormatOption) throws IOException {
return super.createImageBuilder(fileFormatOption).styled(this);
}
public HColor calculateBackColor() {
final Style style = StyleSignatureBasic.of(SName.root, SName.document, this.getUmlDiagramType().getStyleName())
.getMergedStyle(this.getSkinParam().getCurrentStyleBuilder());
HColor backgroundColor = style.value(PName.BackGroundColor).asColor(this.getSkinParam().getIHtmlColorSet());
if (backgroundColor == null)
backgroundColor = HColors.transparent();
return backgroundColor;
}
@Override
protected ColorMapper muteColorMapper(ColorMapper init) {
if ("dark".equalsIgnoreCase(getSkinParam().getValue("mode")))
return ColorMapper.DARK_MODE;
final String monochrome = getSkinParam().getValue("monochrome");
if ("true".equals(monochrome))
return ColorMapper.MONOCHROME;
if ("reverse".equals(monochrome))
return ColorMapper.MONOCHROME_REVERSE;
final String reversecolor = getSkinParam().getValue("reversecolor");
if (reversecolor == null)
return init;
if ("dark".equalsIgnoreCase(reversecolor))
return ColorMapper.LIGTHNESS_INVERSE;
final ColorOrder order = ColorOrder.fromString(reversecolor);
if (order == null)
return init;
return ColorMapper.reverse(order);
}
protected abstract TextBlock getTextMainBlock(FileFormatOption fileFormatOption);
@Override
public void exportDiagramGraphic(UGraphic ug, FileFormatOption fileFormatOption) {
final TextBlock textBlock = getTextMainBlock(fileFormatOption);
textBlock.drawU(ug);
}
}