net.sourceforge.plantuml.asciiart.ComponentTextGroupingHeader 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.asciiart;
import net.sourceforge.plantuml.FileFormat;
import net.sourceforge.plantuml.StringUtils;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.drawing.txt.UGraphicTxt;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.skin.Area;
import net.sourceforge.plantuml.skin.ComponentType;
import net.sourceforge.plantuml.skin.Context2D;
public class ComponentTextGroupingHeader extends AbstractComponentText {
private final ComponentType type;
private final Display stringsToDisplay;
private final FileFormat fileFormat;
public ComponentTextGroupingHeader(ComponentType type, Display stringsToDisplay, FileFormat fileFormat) {
this.type = type;
this.stringsToDisplay = stringsToDisplay;
this.fileFormat = fileFormat;
}
public void drawU(UGraphic ug, Area area, Context2D context) {
final XDimension2D dimensionToUse = area.getDimensionToUse();
final UmlCharArea charArea = ((UGraphicTxt) ug).getCharArea();
final int width = (int) dimensionToUse.getWidth();
final int height = (int) dimensionToUse.getHeight();
// charArea.fillRect('G', 0, 0, width, height);
final String text = stringsToDisplay.get(0).toString();
if (fileFormat == FileFormat.UTXT) {
charArea.drawHLine('\u2550', 0, 1, width - 1, '\u2502', '\u256a');
charArea.drawStringLR(StringUtils.goUpperCase(text) + " /", 2, 1);
charArea.drawHLine('\u2500', 2, 1, text.length() + 4);
charArea.drawVLine('\u2551', 0, 1, height - 1);
charArea.drawVLine('\u2551', width - 1, 1, height - 1);
charArea.drawChar('\u255f', 0, 2);
charArea.drawStringTB("\u2564\u2502\u2518", text.length() + 4, 0);
charArea.drawChar('\u2554', 0, 0);
charArea.drawChar('\u2557', width - 1, 0);
charArea.drawHLine('\u2550', height - 1, 1, width - 1, '\u2502', '\u256a');
charArea.drawChar('\u255a', 0, height - 1);
charArea.drawChar('\u255d', width - 1, height - 1);
} else {
charArea.drawHLine('_', 0, 0, width - 1);
charArea.drawStringLR(StringUtils.goUpperCase(text) + " /", 2, 1);
charArea.drawHLine('_', 2, 1, text.length() + 3);
charArea.drawChar('/', text.length() + 3, 2);
charArea.drawVLine('!', 0, 1, height);
charArea.drawVLine('!', width - 1, 1, height);
charArea.drawHLine('~', height - 1, 1, width - 1);
}
if (stringsToDisplay.size() > 1 && stringsToDisplay.get(1) != null) {
final String comment = stringsToDisplay.get(1).toString();
charArea.drawStringLR(comment, text.length() + 7, 1);
}
}
public double getPreferredHeight(StringBounder stringBounder) {
return StringUtils.getHeight(stringsToDisplay) + 1;
}
public double getPreferredWidth(StringBounder stringBounder) {
return StringUtils.getWcWidth(stringsToDisplay) + 2;
}
}