plantuml/src/net/sourceforge/plantuml/ISkinParam.java

197 lines
5.5 KiB
Java
Raw Normal View History

2010-11-15 20:35:36 +00:00
/* ========================================================================
* PlantUML : a free UML diagram generator
* ========================================================================
*
2022-03-07 19:33:46 +00:00
* (C) Copyright 2009-2023, Arnaud Roques
2010-11-15 20:35:36 +00:00
*
2016-03-06 16:47:34 +00:00
* Project Info: http://plantuml.com
2010-11-15 20:35:36 +00:00
*
2017-03-15 19:13:31 +00:00
* If you like this project or if you find it useful, you can support us at:
*
* http://plantuml.com/patreon (only 1$ per month!)
* http://plantuml.com/paypal
*
2010-11-15 20:35:36 +00:00
* This file is part of PlantUML.
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU 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
2013-12-10 19:36:50 +00:00
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
2010-11-15 20:35:36 +00:00
* License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
*
* Original Author: Arnaud Roques
*
*
*/
package net.sourceforge.plantuml;
2019-08-26 17:07:21 +00:00
import java.util.Collection;
2022-11-30 17:41:17 +00:00
import net.sourceforge.plantuml.activitydiagram3.ftile.Arrows;
2015-04-07 18:18:37 +00:00
import net.sourceforge.plantuml.cucadiagram.Rankdir;
import net.sourceforge.plantuml.cucadiagram.Stereotype;
2011-03-26 12:37:27 +00:00
import net.sourceforge.plantuml.cucadiagram.dot.DotSplines;
2013-12-10 19:36:50 +00:00
import net.sourceforge.plantuml.graphic.HorizontalAlignment;
2015-09-28 20:42:17 +00:00
import net.sourceforge.plantuml.graphic.color.Colors;
2019-12-10 21:45:49 +00:00
import net.sourceforge.plantuml.skin.ActorStyle;
2016-11-04 21:39:29 +00:00
import net.sourceforge.plantuml.skin.ArrowDirection;
2019-07-14 20:09:26 +00:00
import net.sourceforge.plantuml.skin.Padder;
import net.sourceforge.plantuml.style.Style;
import net.sourceforge.plantuml.style.StyleBuilder;
2019-06-26 19:24:49 +00:00
import net.sourceforge.plantuml.svek.ConditionEndStyle;
2013-12-10 19:36:50 +00:00
import net.sourceforge.plantuml.svek.ConditionStyle;
import net.sourceforge.plantuml.svek.PackageStyle;
2021-01-10 20:52:19 +00:00
import net.sourceforge.plantuml.svg.LengthAdjust;
2011-08-08 17:48:29 +00:00
import net.sourceforge.plantuml.ugraphic.UFont;
2013-12-10 19:36:50 +00:00
import net.sourceforge.plantuml.ugraphic.UStroke;
2020-03-18 10:50:02 +00:00
import net.sourceforge.plantuml.ugraphic.color.HColor;
2021-02-02 10:12:15 +00:00
import net.sourceforge.plantuml.ugraphic.color.NoSuchColorException;
2010-11-15 20:35:36 +00:00
2015-04-07 18:18:37 +00:00
public interface ISkinParam extends ISkinSimple {
2010-11-15 20:35:36 +00:00
2018-07-27 21:56:46 +00:00
public static final int SWIMLANE_WIDTH_SAME = -1;
2020-03-18 10:50:02 +00:00
public HColor getHyperlinkColor();
2015-04-07 18:18:37 +00:00
2022-10-05 20:32:57 +00:00
public UStroke useUnderlineForHyperlink();
2010-11-15 20:35:36 +00:00
public HColor getBackgroundColor();
2010-11-15 20:35:36 +00:00
2020-03-18 10:50:02 +00:00
public HColor getHtmlColor(ColorParam param, Stereotype stereotype, boolean clickable);
2010-11-15 20:35:36 +00:00
2021-02-02 10:12:15 +00:00
public Colors getColors(ColorParam param, Stereotype stereotype) throws NoSuchColorException;
2015-09-28 20:42:17 +00:00
2020-03-18 10:50:02 +00:00
public HColor getFontHtmlColor(Stereotype stereotype, FontParam... param);
2010-11-15 20:35:36 +00:00
2015-04-07 18:18:37 +00:00
public UStroke getThickness(LineParam param, Stereotype stereotype);
2013-12-10 19:36:50 +00:00
2016-01-09 12:15:40 +00:00
public UFont getFont(Stereotype stereotype, boolean inPackageTitle, FontParam... fontParam);
2013-12-10 19:36:50 +00:00
2018-12-22 11:11:40 +00:00
public HorizontalAlignment getHorizontalAlignment(AlignmentParam param, ArrowDirection arrowDirection,
2021-06-27 16:50:40 +00:00
boolean isReverseDefine, HorizontalAlignment overrideDefault);
2010-11-15 20:35:36 +00:00
2016-07-04 19:06:50 +00:00
public HorizontalAlignment getDefaultTextAlignment(HorizontalAlignment defaultValue);
2015-04-07 18:18:37 +00:00
2019-05-24 19:59:31 +00:00
public HorizontalAlignment getStereotypeAlignment();
2010-11-15 20:35:36 +00:00
public int getCircledCharacterRadius();
2018-03-09 21:37:34 +00:00
public char getCircledCharacter(Stereotype stereotype);
2010-11-15 20:35:36 +00:00
public int classAttributeIconSize();
2013-12-10 19:36:50 +00:00
2011-03-26 12:37:27 +00:00
public DotSplines getDotSplines();
2013-12-10 19:36:50 +00:00
2018-09-23 12:15:14 +00:00
public boolean shadowing(Stereotype stereotype);
2016-12-01 20:29:25 +00:00
2015-11-01 18:37:20 +00:00
public boolean shadowingForNote(Stereotype stereotype);
2013-12-10 19:36:50 +00:00
2020-06-21 20:31:45 +00:00
public PackageStyle packageStyle();
2013-12-10 19:36:50 +00:00
2020-06-14 20:35:42 +00:00
public ComponentStyle componentStyle();
2013-12-10 19:36:50 +00:00
public boolean stereotypePositionTop();
2015-04-07 18:18:37 +00:00
public boolean useSwimlanes(UmlDiagramType type);
2013-12-10 19:36:50 +00:00
public double getNodesep();
public double getRanksep();
2018-04-06 20:36:30 +00:00
public double getRoundCorner(CornerParam param, Stereotype stereotype);
public double getDiagonalCorner(CornerParam param, Stereotype stereotype);
2013-12-10 19:36:50 +00:00
2017-02-26 16:26:11 +00:00
public LineBreakStrategy maxMessageSize();
2013-12-10 19:36:50 +00:00
2018-07-27 21:56:46 +00:00
public LineBreakStrategy swimlaneWrapTitleWidth();
2013-12-10 19:36:50 +00:00
public boolean strictUmlStyle();
public boolean forceSequenceParticipantUnderlined();
public ConditionStyle getConditionStyle();
2015-04-07 18:18:37 +00:00
2019-06-26 19:24:49 +00:00
public ConditionEndStyle getConditionEndStyle();
2019-07-14 20:09:26 +00:00
2013-12-10 19:36:50 +00:00
public boolean sameClassWidth();
2010-11-15 20:35:36 +00:00
2015-04-07 18:18:37 +00:00
public Rankdir getRankdir();
public boolean useOctagonForActivity(Stereotype stereotype);
public int groupInheritance();
2015-09-28 20:42:17 +00:00
2019-03-29 22:14:07 +00:00
public Guillemet guillemet();
2015-04-07 18:18:37 +00:00
public boolean handwritten();
2015-05-31 18:56:03 +00:00
public String getSvgLinkTarget();
2016-12-01 20:29:25 +00:00
2019-11-03 17:40:03 +00:00
public String getPreserveAspectRatio();
2015-09-28 20:42:17 +00:00
public int getTabSize();
2016-12-01 20:29:25 +00:00
2016-02-07 21:13:01 +00:00
public int maxAsciiMessageLength();
2016-12-01 20:29:25 +00:00
2016-05-11 21:31:47 +00:00
public int colorArrowSeparationSpace();
2016-12-01 20:29:25 +00:00
2016-11-04 21:39:29 +00:00
public SplitParam getSplitParam();
2016-05-11 21:31:47 +00:00
2016-12-01 20:29:25 +00:00
public int swimlaneWidth();
2017-02-26 16:26:11 +00:00
2017-02-15 21:34:36 +00:00
public UmlDiagramType getUmlDiagramType();
2017-02-26 16:26:11 +00:00
2020-06-21 20:31:45 +00:00
public HColor hoverPathColor();
2017-02-15 21:34:36 +00:00
2017-10-07 09:46:53 +00:00
public TikzFontDistortion getTikzFontDistortion();
2017-02-26 16:26:11 +00:00
public double getPadding(PaddingParam param);
2017-10-07 09:46:53 +00:00
2017-06-05 11:27:21 +00:00
public boolean useRankSame();
2017-10-07 09:46:53 +00:00
2017-09-03 16:59:24 +00:00
public boolean displayGenericWithOldFashion();
2015-05-31 18:56:03 +00:00
2018-03-09 21:37:34 +00:00
public boolean responseMessageBelowArrow();
public boolean svgDimensionStyle();
2018-12-22 11:11:40 +00:00
2018-08-26 12:09:50 +00:00
public boolean fixCircleLabelOverlapping();
2018-03-09 21:37:34 +00:00
2018-12-22 11:11:40 +00:00
public void setUseVizJs(boolean useVizJs);
public boolean isUseVizJs();
2020-06-21 20:31:45 +00:00
public Padder sequenceDiagramPadder();
2019-07-14 20:09:26 +00:00
public StyleBuilder getCurrentStyleBuilder();
public void muteStyle(Style modifiedStyle);
2019-08-26 17:07:21 +00:00
public Collection<String> getAllSpriteNames();
2019-12-10 21:45:49 +00:00
2019-08-26 17:07:21 +00:00
public String getDefaultSkin();
2019-12-10 21:45:49 +00:00
2019-08-26 17:07:21 +00:00
public void setDefaultSkin(String newSkin);
2020-06-21 20:31:45 +00:00
public ActorStyle actorStyle();
2019-08-26 17:07:21 +00:00
2020-12-06 21:43:09 +00:00
public void setSvgSize(String origin, String sizeToUse);
2021-05-06 21:23:05 +00:00
2021-01-10 20:52:19 +00:00
public LengthAdjust getlengthAdjust();
2022-10-18 20:57:44 +00:00
public double getParamSameClassWidth();
2022-11-30 17:41:17 +00:00
public Arrows arrows();
}