net.sourceforge.plantuml.svek.image.EntityImageClassHeader 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.svek.image;
import net.sourceforge.plantuml.abel.Entity;
import net.sourceforge.plantuml.abel.EntityPortion;
import net.sourceforge.plantuml.abel.LeafType;
import net.sourceforge.plantuml.cucadiagram.PortionShower;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.CreoleMode;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.drawing.UGraphic;
import net.sourceforge.plantuml.klimt.font.FontConfiguration;
import net.sourceforge.plantuml.klimt.font.FontParam;
import net.sourceforge.plantuml.klimt.font.StringBounder;
import net.sourceforge.plantuml.klimt.font.UFont;
import net.sourceforge.plantuml.klimt.geom.HorizontalAlignment;
import net.sourceforge.plantuml.klimt.geom.VerticalAlignment;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.klimt.shape.CircledCharacter;
import net.sourceforge.plantuml.klimt.shape.TextBlock;
import net.sourceforge.plantuml.klimt.shape.TextBlockGeneric;
import net.sourceforge.plantuml.klimt.shape.TextBlockUtils;
import net.sourceforge.plantuml.skin.SkinParamUtils;
import net.sourceforge.plantuml.skin.VisibilityModifier;
import net.sourceforge.plantuml.skin.rose.Rose;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.PName;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.svek.AbstractEntityImage;
import net.sourceforge.plantuml.svek.HeaderLayout;
import net.sourceforge.plantuml.svek.ShapeType;
import net.sourceforge.plantuml.text.Guillemet;
import java.util.List;
public class EntityImageClassHeader extends AbstractEntityImage {
final private HeaderLayout headerLayout;
public EntityImageClassHeader(Entity entity, ISkinParam skinParam, PortionShower portionShower) {
super(entity, skinParam);
final boolean italic = entity.getLeafType() == LeafType.ABSTRACT_CLASS
|| entity.getLeafType() == LeafType.INTERFACE;
final Stereotype stereotype = entity.getStereotype();
final boolean displayGenericWithOldFashion = skinParam.displayGenericWithOldFashion();
final String generic = displayGenericWithOldFashion ? null : entity.getGeneric();
final Style style = StyleSignatureBasic
.of(SName.root, SName.element, SName.classDiagram, SName.class_, SName.header) //
.withTOBECHANGED(stereotype) //
.with(entity.getStereostyles()) //
.getMergedStyle(skinParam.getCurrentStyleBuilder());
FontConfiguration fontConfigurationName = FontConfiguration.create(skinParam, style, entity.getColors());
if (italic)
fontConfigurationName = fontConfigurationName.italic();
Display display = entity.getDisplay();
if (displayGenericWithOldFashion && entity.getGeneric() != null)
display = display.addGeneric(entity.getGeneric());
TextBlock name = display.create8(fontConfigurationName, HorizontalAlignment.CENTER, skinParam,
CreoleMode.FULL_BUT_UNDERSCORE, style.wrapWidth());
final VisibilityModifier modifier = entity.getVisibilityModifier();
if (modifier == null) {
name = TextBlockUtils.withMargin(name, 3, 3, 0, 0);
} else {
final Rose rose = new Rose();
final HColor back = rose.getHtmlColor(skinParam, modifier.getBackground());
final HColor fore = rose.getHtmlColor(skinParam, modifier.getForeground());
final TextBlock uBlock = modifier.getUBlock(skinParam.classAttributeIconSize(), fore, back, false);
name = TextBlockUtils.mergeLR(uBlock, name, VerticalAlignment.CENTER);
name = TextBlockUtils.withMargin(name, 3, 3, 0, 0);
}
final TextBlock stereo;
List stereotypeLabels = portionShower.getVisibleStereotypeLabels(entity);
if (stereotype == null || stereotype.getLabel(Guillemet.DOUBLE_COMPARATOR) == null
|| stereotypeLabels.isEmpty())
stereo = null;
else
stereo = TextBlockUtils.withMargin(Display.create(stereotypeLabels).create(
FontConfiguration.create(getSkinParam(), FontParam.CLASS_STEREOTYPE, stereotype),
HorizontalAlignment.CENTER, skinParam), 1, 0);
TextBlock genericBlock;
if (generic == null) {
genericBlock = null;
} else {
genericBlock = Display.getWithNewlines(generic).create(
FontConfiguration.create(getSkinParam(), FontParam.CLASS_STEREOTYPE, stereotype),
HorizontalAlignment.CENTER, skinParam);
genericBlock = TextBlockUtils.withMargin(genericBlock, 1, 1);
final HColor classBackground = skinParam.getBackgroundColor();
final HColor classBorder = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
genericBlock = new TextBlockGeneric(genericBlock, classBackground, classBorder);
genericBlock = TextBlockUtils.withMargin(genericBlock, 1, 1);
}
final TextBlock circledCharacter;
if (portionShower.showPortion(EntityPortion.CIRCLED_CHARACTER, (Entity) getEntity()))
circledCharacter = TextBlockUtils.withMargin(getCircledCharacter(entity, skinParam), 4, 0, 5, 5);
else
circledCharacter = null;
this.headerLayout = new HeaderLayout(circledCharacter, stereo, name, genericBlock);
}
private TextBlock getCircledCharacter(Entity entity, ISkinParam skinParam) {
final Stereotype stereotype = entity.getStereotype();
if (stereotype != null && stereotype.getSprite(skinParam) != null)
return stereotype.getSprite(skinParam);
final UFont font = SkinParamUtils.getFont(getSkinParam(), FontParam.CIRCLED_CHARACTER, null);
final LeafType leafType = entity.getLeafType();
final Style style = spotStyleSignature(leafType).getMergedStyle(skinParam.getCurrentStyleBuilder());
final HColor spotBorder = style.value(PName.LineColor).asColor(skinParam.getIHtmlColorSet());
final HColor spotBackColor = style.value(PName.BackGroundColor).asColor(skinParam.getIHtmlColorSet());
final HColor fontColor = style.value(PName.FontColor).asColor(skinParam.getIHtmlColorSet());
if (stereotype != null && stereotype.getCharacter() != 0)
return new CircledCharacter(stereotype.getCharacter(), getSkinParam().getCircledCharacterRadius(), font,
stereotype.getHtmlColor(), spotBorder, fontColor);
char circledChar = 0;
if (stereotype != null)
circledChar = getSkinParam().getCircledCharacter(stereotype);
if (circledChar == 0)
circledChar = getCircledChar(leafType);
return new CircledCharacter(circledChar, getSkinParam().getCircledCharacterRadius(), font, spotBackColor,
spotBorder, fontColor);
}
private StyleSignatureBasic spotStyleSignature(LeafType leafType) {
switch (leafType) {
case ANNOTATION:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotAnnotation);
case ABSTRACT_CLASS:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotAbstractClass);
case CLASS:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotClass);
case INTERFACE:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotInterface);
case ENUM:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotEnum);
case ENTITY:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotEntity);
case PROTOCOL:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotProtocol);
case STRUCT:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotStruct);
case EXCEPTION:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotException);
case METACLASS:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotMetaClass);
case STEREOTYPE:
return StyleSignatureBasic.of(SName.root, SName.element, SName.spot, SName.spotStereotype);
}
throw new IllegalStateException();
}
private char getCircledChar(LeafType leafType) {
switch (leafType) {
case ANNOTATION:
return '@';
case ABSTRACT_CLASS:
return 'A';
case CLASS:
return 'C';
case INTERFACE:
return 'I';
case ENUM:
return 'E';
case ENTITY:
return 'E';
case PROTOCOL:
return 'P';
case STRUCT:
return 'S';
case EXCEPTION:
return 'X';
case METACLASS:
return 'M';
case STEREOTYPE:
return 'S';
}
assert false;
return '?';
}
public XDimension2D calculateDimension(StringBounder stringBounder) {
return headerLayout.getDimension(stringBounder);
}
final public void drawU(UGraphic ug) {
throw new UnsupportedOperationException();
}
public void drawU(UGraphic ug, double width, double height) {
headerLayout.drawU(ug, width, height);
}
public ShapeType getShapeType() {
return ShapeType.RECTANGLE;
}
}