com.nomagic.magicdraw.uml.symbols.shapes.html

Class HTMLHelper

java.lang.Object

com.nomagic.magicdraw.uml.symbols.shapes.html.HTMLHelper

@OpenApiAll
public class HTMLHelper
extends java.lang.Object

The class is used for html document creation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	HTMLHelper.Renderer Root text view that acts as an HTML renderer.

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.URL	BASE
static java.lang.String	MD_ICON_TAG

Constructor Summary

Constructors

Constructor and Description
HTMLHelper()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	applyFontSizeStyleSheetColorOnP(java.lang.String html, java.awt.Font font, boolean ptUnits, int red, int green, int blue) Apply font size style and color on
static java.lang.String	applyFontSizeStyleSheetOnBody(java.lang.String html, java.awt.Font font, boolean ptUnits) Apply font size style on tag in the given html text.
static java.lang.String	applyFontSizeStyleSheetOnP(java.lang.String html, java.awt.Font font, boolean ptUnits) Apply font size style on
static void	applyStyleSheet(javax.swing.text.html.StyleSheet styles, com.nomagic.magicdraw.uml.symbols.shapes.TextObject obj, java.util.function.Function<java.awt.Color,java.awt.Color> dynamicStyle, boolean takeZoomFactor) Changes the properties of the given style sheet according to the properties of the given text object.
static java.lang.String	constructHTMLText(java.lang.String text) Adds the html info to the given text in order to display it as HTML.
static java.lang.String	constructHTMLText(java.lang.String text, boolean convertCharacters, boolean addEnterAfterP) Adds the html info to the given text in order to display it as HTML.
static javax.swing.text.View	createHTMLView(javax.swing.text.html.StyleSheet sheet, com.nomagic.magicdraw.uml.symbols.shapes.TextObject object, java.lang.String html, java.util.function.Function<java.awt.Color,java.awt.Color> dynamicStyle, Project project) Create an html renderer for the text object and string of html.
static java.lang.String	getHTMLBody(java.lang.String html)
static java.lang.String	getPureText(javax.swing.text.Document doc) Returns the pure text.
static java.lang.String	getPureTextFromHTMLSource(java.lang.String source) Get Pure text from html source.
static java.lang.String	getSelectedHTMLSource(javax.swing.JEditorPane htmlPane) Get Selected html source.
static boolean	isHTMLText(java.lang.String s) Check the given string to see if it should trigger the html rendering logic.
static java.lang.String	makeEndTag(java.lang.String tag) Create end tag for the given tag.
static java.lang.String	makeStartTag(java.lang.String tag) Create start tag for the given tag.
static java.lang.String	removeColorTagsWithValue(java.lang.String pureText)
static java.lang.String	removeHTMLHeader(java.lang.String html) Remove HTML Header from the given Val.
static void	setPStyleProperties(javax.swing.text.html.StyleSheet styleSheet, int fontSize, java.lang.String family, java.awt.Color foreground) Set Style property
static java.lang.String	stringToHTMLString(java.lang.String string)
static java.lang.String	wrapAsHTML(java.lang.String text)
static java.lang.StringBuilder	wrapAsHTML(java.lang.StringBuilder text)
static java.lang.String	wrapAsHTMLDocument(java.lang.String text)
static java.lang.String	wrapByHtmlBody(java.lang.String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MD_ICON_TAG

public static final java.lang.String MD_ICON_TAG

See Also:

Constant Field Values

BASE

public static java.net.URL BASE

Constructor Detail

HTMLHelper

public HTMLHelper()

Method Detail

applyFontSizeStyleSheetOnP

@Nonnull
public static java.lang.String applyFontSizeStyleSheetOnP(@Nonnull
                                                                   java.lang.String html,
                                                                   @Nonnull
                                                                   java.awt.Font font,
                                                                   boolean ptUnits)

Apply font size style on

tags in the given html text

Parameters:

html - html text

font - font

ptUnits - use "pt" or "px" units for font size

Returns:

html with changed style

applyFontSizeStyleSheetColorOnP

@Nonnull
public static java.lang.String applyFontSizeStyleSheetColorOnP(@Nonnull
                                                                        java.lang.String html,
                                                                        @Nonnull
                                                                        java.awt.Font font,
                                                                        boolean ptUnits,
                                                                        int red,
                                                                        int green,
                                                                        int blue)

Apply font size style and color on

tags in the given html text.

Parameters:

html - text.

font - text font.

ptUnits - use "pt" or "px" units for font size

red - color code.

green - color code.

blue - color code.

Returns:

html with changed style.

applyFontSizeStyleSheetOnBody

@Nonnull
public static java.lang.String applyFontSizeStyleSheetOnBody(@Nonnull
                                                                      java.lang.String html,
                                                                      @Nonnull
                                                                      java.awt.Font font,
                                                                      boolean ptUnits)

Apply font size style on tag in the given html text.

Parameters:

html - text.

font - text font.

ptUnits - use "pt" or "px" units for font size

Returns:

html with changed style.

createHTMLView

public static javax.swing.text.View createHTMLView(@CheckForNull
                                                   javax.swing.text.html.StyleSheet sheet,
                                                   @Nonnull
                                                   com.nomagic.magicdraw.uml.symbols.shapes.TextObject object,
                                                   @Nonnull
                                                   java.lang.String html,
                                                   @CheckForNull
                                                   java.util.function.Function<java.awt.Color,java.awt.Color> dynamicStyle,
                                                   @CheckForNull
                                                   Project project)

Create an html renderer for the text object and string of html.

Parameters:

sheet - the style sheet of the document.

object - the given text object.

html - the given html text.

wrapAsHTML

public static java.lang.String wrapAsHTML(@Nonnull
                                          java.lang.String text)

wrapAsHTML

public static java.lang.StringBuilder wrapAsHTML(java.lang.StringBuilder text)

wrapAsHTMLDocument

@Nonnull
public static java.lang.String wrapAsHTMLDocument(@Nonnull
                                                           java.lang.String text)

wrapByHtmlBody

public static java.lang.String wrapByHtmlBody(java.lang.String text)

stringToHTMLString

@Nonnull
public static java.lang.String stringToHTMLString(@Nonnull
                                                           java.lang.String string)

applyStyleSheet

public static void applyStyleSheet(@Nonnull
                                   javax.swing.text.html.StyleSheet styles,
                                   @Nonnull
                                   com.nomagic.magicdraw.uml.symbols.shapes.TextObject obj,
                                   @CheckForNull
                                   java.util.function.Function<java.awt.Color,java.awt.Color> dynamicStyle,
                                   boolean takeZoomFactor)

Changes the properties of the given style sheet according to the properties of the given text object.

Parameters:

styles - the given style sheet.

obj - the given text object.

setPStyleProperties

public static void setPStyleProperties(@Nonnull
                                       javax.swing.text.html.StyleSheet styleSheet,
                                       int fontSize,
                                       @Nonnull
                                       java.lang.String family,
                                       @Nonnull
                                       java.awt.Color foreground)

Set Style property

Parameters:

styleSheet - Style sheet

fontSize - Font size.

family - Font Family

foreground - Fore ground color.

removeColorTagsWithValue

public static java.lang.String removeColorTagsWithValue(java.lang.String pureText)

getPureText

public static java.lang.String getPureText(javax.swing.text.Document doc)

Returns the pure text.

Returns:

the pure text (without the html tags)

getPureTextFromHTMLSource

public static java.lang.String getPureTextFromHTMLSource(java.lang.String source)

Get Pure text from html source.

Parameters:

source - The given html source.

Returns:

pure text from html source.

isHTMLText

public static boolean isHTMLText(@CheckForNull
                                 java.lang.String s)

Check the given string to see if it should trigger the html rendering logic.

Parameters:

s - the given string.

removeHTMLHeader

public static java.lang.String removeHTMLHeader(java.lang.String html)

Remove HTML Header from the given Val.

Parameters:

html - The given HTML Source.

Returns:

Removed HTML Header source.

getHTMLBody

public static java.lang.String getHTMLBody(java.lang.String html)

constructHTMLText

public static java.lang.String constructHTMLText(java.lang.String text)

Adds the html info to the given text in order to display it as HTML.

Parameters:

text - the given text.

Returns:

the html text.

constructHTMLText

@Nonnull
public static java.lang.String constructHTMLText(@Nonnull
                                                          java.lang.String text,
                                                          boolean convertCharacters,
                                                          boolean addEnterAfterP)

Adds the html info to the given text in order to display it as HTML.

Parameters:

text - the given text.

Returns:

the html text.

getSelectedHTMLSource

@Nonnull
public static java.lang.String getSelectedHTMLSource(@Nonnull
                                                              javax.swing.JEditorPane htmlPane)

Get Selected html source.

Parameters:

htmlPane - instance of JEditorPane

Returns:

selected HTML source

makeStartTag

public static java.lang.String makeStartTag(java.lang.String tag)

Create start tag for the given tag.

Parameters:

tag - The given tag.

Returns:

tag wrapped to

makeEndTag

public static java.lang.String makeEndTag(java.lang.String tag)

Create end tag for the given tag.

Parameters:

tag - The given tag.

Returns:

tag wrapped to