net.sourceforge.plantuml.wbs.WElement Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plantuml-epl Show documentation
Show all versions of plantuml-epl 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 Eclipse Public License.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [Eclipse Public License - v 1.0]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* http://www.eclipse.org/legal/epl-v10.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 EPL license.
*
* The generated images can then be used without any reference to the EPL 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.wbs;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import net.sourceforge.plantuml.klimt.UTranslate;
import net.sourceforge.plantuml.klimt.color.ColorType;
import net.sourceforge.plantuml.klimt.color.Colors;
import net.sourceforge.plantuml.klimt.color.HColor;
import net.sourceforge.plantuml.klimt.creole.Display;
import net.sourceforge.plantuml.klimt.geom.XDimension2D;
import net.sourceforge.plantuml.mindmap.IdeaShape;
import net.sourceforge.plantuml.skin.SkinParamColors;
import net.sourceforge.plantuml.stereo.Stereotype;
import net.sourceforge.plantuml.style.ISkinParam;
import net.sourceforge.plantuml.style.MergeStrategy;
import net.sourceforge.plantuml.style.SName;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
import net.sourceforge.plantuml.style.StyleSignatureBasic;
import net.sourceforge.plantuml.utils.Direction;
final public class WElement {
private final HColor backColor;
private final Display label;
private final int level;
private final Stereotype stereotype;
private final WElement parent;
private final StyleBuilder styleBuilder;
private final List childrenLeft = new ArrayList<>();
private final List childrenRight = new ArrayList<>();
private final IdeaShape shape;
private UTranslate position;
private XDimension2D dimension;
private StyleSignatureBasic getDefaultStyleDefinitionNode(int level) {
final String depth = SName.depth(level);
if (level == 0)
return StyleSignatureBasic.of(SName.root, SName.element, SName.wbsDiagram, SName.node, SName.rootNode)
.addS(stereotype).add(depth);
if (shape == IdeaShape.NONE && isLeaf())
return StyleSignatureBasic
.of(SName.root, SName.element, SName.wbsDiagram, SName.node, SName.leafNode, SName.boxless)
.addS(stereotype).add(depth);
if (isLeaf())
return StyleSignatureBasic.of(SName.root, SName.element, SName.wbsDiagram, SName.node, SName.leafNode)
.addS(stereotype).add(depth);
if (shape == IdeaShape.NONE)
return StyleSignatureBasic.of(SName.root, SName.element, SName.wbsDiagram, SName.node, SName.boxless)
.addS(stereotype).add(depth);
return StyleSignatureBasic.of(SName.root, SName.element, SName.wbsDiagram, SName.node).addS(stereotype)
.add(depth);
}
public ISkinParam withBackColor(ISkinParam skinParam) {
if (backColor == null)
return skinParam;
return new SkinParamColors(skinParam, Colors.empty().add(ColorType.BACK, backColor));
}
public static final int STEP_BY_PARENT = 1000_1000;
public Style getStyle() {
int deltaPriority = STEP_BY_PARENT * 1000;
Style result = styleBuilder.getMergedStyleSpecial(getDefaultStyleDefinitionNode(level), deltaPriority);
for (WElement up = parent; up != null; up = up.parent) {
final StyleSignatureBasic ss = up.getDefaultStyleDefinitionNode(level).addStar();
deltaPriority -= STEP_BY_PARENT;
final Style styleParent = styleBuilder.getMergedStyleSpecial(ss, deltaPriority);
result = result.mergeWith(styleParent, MergeStrategy.OVERWRITE_EXISTING_VALUE);
}
return result;
}
public WElement(HColor backColor, Display label, Stereotype stereotype, StyleBuilder styleBuilder, IdeaShape shape) {
this(backColor, 0, label, stereotype, null, shape, styleBuilder);
}
private WElement(HColor backColor, int level, Display label, Stereotype stereotype, WElement parent, IdeaShape shape,
StyleBuilder styleBuilder) {
this.label = label;
this.backColor = backColor;
this.level = level;
this.parent = parent;
this.shape = shape;
this.styleBuilder = styleBuilder;
this.stereotype = stereotype;
}
public boolean isLeaf() {
return childrenLeft.size() == 0 && childrenRight.size() == 0;
}
public WElement createElement(HColor backColor, int newLevel, Display newLabel, Stereotype stereotype,
Direction direction, IdeaShape shape, StyleBuilder styleBuilder) {
final WElement result = new WElement(backColor, newLevel, newLabel, stereotype, this, shape, styleBuilder);
if (direction == Direction.LEFT && newLevel == 1)
this.childrenRight.add(0, result);
if (direction == Direction.LEFT)
this.childrenLeft.add(result);
else
this.childrenRight.add(result);
return result;
}
@Override
public String toString() {
return label.toString();
}
public final int getLevel() {
return level;
}
public final Display getLabel() {
return label;
}
public Collection getChildren(Direction direction) {
if (direction == Direction.LEFT)
return Collections.unmodifiableList(childrenLeft);
return Collections.unmodifiableList(childrenRight);
}
public WElement getParent() {
return parent;
}
public final IdeaShape getShape() {
return shape;
}
public final StyleBuilder getStyleBuilder() {
return styleBuilder;
}
public final void setGeometry(UTranslate position, XDimension2D dimension) {
this.position = position;
this.dimension = dimension;
}
public final UTranslate getPosition() {
return position;
}
public final XDimension2D getDimension() {
return dimension;
}
public Stereotype getStereotype() {
return stereotype;
}
}