Class TagProcessingState
java.lang.Object
org.eclipse.nebula.widgets.richtext.painter.TagProcessingState
public class TagProcessingState
extends java.lang.Object
This class is used to keep track of the style setting regarding opened tags. It is needed to
support styling ranges over several lines or rendering, because tags can be opened for rendering
on one line, while it is closed on another line.
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTagProcessingState.TextAlignmentEnumeration to specify the text alignment in a paragraph. -
Constructor Summary
Constructors Constructor Description TagProcessingState() -
Method Summary
Modifier and Type Method Description voidactivateNextLine()voidaddPreviousBgColor(org.eclipse.swt.graphics.Color prevBgColor)Add the givenColorto the stack of previous set background colors.voidaddPreviousColor(org.eclipse.swt.graphics.Color prevColor)Add the givenColorto the stack of previous set foreground colors.voidaddPreviousFont(org.eclipse.swt.graphics.Font font)Add the givenFontto the stack of previous set fonts.voidcalculateX(int areaWidth)org.eclipse.swt.graphics.FontMetricsgetCurrentBiggestFontMetrics()LinePaintergetCurrentLine()intgetCurrentLineHeight()java.lang.IntegergetCurrentListNumber()intgetListDepth()intgetListMargin()intgetMarginLeft()intgetParagraphCount()org.eclipse.swt.graphics.PointgetPointer()TagProcessingState.TextAlignmentgetTextAlignment()booleanhasPreviousBgColor()voidincreaseCurrentListNumber()voidincreaseParagraphCount()voidincreaseX(int x)voidincreaseY(int y)voidinitCurrentListNumber()booleanisOrderedList()booleanisRendering()booleanisStrikethroughActive()booleanisUnderlineActive()org.eclipse.swt.graphics.ColorpollPreviousBgColor()Removes and returns the last color from the previous background color stack.org.eclipse.swt.graphics.ColorpollPreviousColor()Removes and returns the last color from the previous foreground color stack.org.eclipse.swt.graphics.FontpollPreviousFont()Removes and returns the last font from the previous font stack.voidresetListConfiguration()voidresetX()Reset the x coordinate of the pointer to the value of the left margin.voidsetLineIterator(java.util.Iterator<LinePainter> lineIterator)voidsetListMargin(int listMargin)voidsetMarginLeft(int marginLeft)voidsetOrderedList(boolean orderedList)voidsetRendering(boolean render)voidsetStartingPoint(int startX, int startY)voidsetStrikethroughActive(boolean strikethroughActive)voidsetTextAlignment(TagProcessingState.TextAlignment textAlignment)voidsetUnderlineActive(boolean underlineActive)voidsetX(int x)voidsetY(int y)
-
Constructor Details
-
TagProcessingState
public TagProcessingState()
-
-
Method Details
-
addPreviousColor
public void addPreviousColor(org.eclipse.swt.graphics.Color prevColor)Add the givenColorto the stack of previous set foreground colors.- Parameters:
prevColor- TheColorto add to the previous foreground color stack.
-
pollPreviousColor
public org.eclipse.swt.graphics.Color pollPreviousColor()Removes and returns the last color from the previous foreground color stack. (LIFO)- Returns:
- The last
Colorthat was added to the previous foreground color stack.
-
addPreviousBgColor
public void addPreviousBgColor(org.eclipse.swt.graphics.Color prevBgColor)Add the givenColorto the stack of previous set background colors.- Parameters:
prevBgColor- TheColorto add to the previous background color stack.
-
pollPreviousBgColor
public org.eclipse.swt.graphics.Color pollPreviousBgColor()Removes and returns the last color from the previous background color stack. (LIFO)- Returns:
- The last
Colorthat was added to the previous background color stack.
-
hasPreviousBgColor
public boolean hasPreviousBgColor()- Returns:
trueif there is a previous background color registered on the stack,falseif not.
-
addPreviousFont
public void addPreviousFont(org.eclipse.swt.graphics.Font font)Add the givenFontto the stack of previous set fonts.- Parameters:
font- TheFontto add to the previous font stack
-
pollPreviousFont
public org.eclipse.swt.graphics.Font pollPreviousFont()Removes and returns the last font from the previous font stack. (LIFO)- Returns:
- The last
Fontthat was added to the previous font stack.
-
isUnderlineActive
public boolean isUnderlineActive()- Returns:
trueif underline styling is active,falseif not.
-
setUnderlineActive
public void setUnderlineActive(boolean underlineActive)- Parameters:
underlineActive-trueif underline styling should be active,falseif not.
-
isStrikethroughActive
public boolean isStrikethroughActive()- Returns:
trueif strikethrough styling is active,falseif not.
-
setStrikethroughActive
public void setStrikethroughActive(boolean strikethroughActive)- Parameters:
strikethroughActive-trueif strikethrough styling should be active,falseif not.
-
setStartingPoint
public void setStartingPoint(int startX, int startY) -
getPointer
public org.eclipse.swt.graphics.Point getPointer() -
increaseX
public void increaseX(int x) -
increaseY
public void increaseY(int y) -
setX
public void setX(int x) -
setY
public void setY(int y) -
resetX
public void resetX()Reset the x coordinate of the pointer to the value of the left margin. This is used to start a new line. -
calculateX
public void calculateX(int areaWidth) -
getMarginLeft
public int getMarginLeft() -
setMarginLeft
public void setMarginLeft(int marginLeft) -
getTextAlignment
-
setTextAlignment
-
getCurrentLine
-
setLineIterator
-
activateNextLine
public void activateNextLine() -
getCurrentLineHeight
public int getCurrentLineHeight() -
getCurrentBiggestFontMetrics
public org.eclipse.swt.graphics.FontMetrics getCurrentBiggestFontMetrics() -
isRendering
public boolean isRendering() -
setRendering
public void setRendering(boolean render) -
isOrderedList
public boolean isOrderedList() -
setOrderedList
public void setOrderedList(boolean orderedList) -
getListMargin
public int getListMargin() -
setListMargin
public void setListMargin(int listMargin) -
getCurrentListNumber
public java.lang.Integer getCurrentListNumber() -
initCurrentListNumber
public void initCurrentListNumber() -
increaseCurrentListNumber
public void increaseCurrentListNumber() -
getListDepth
public int getListDepth() -
resetListConfiguration
public void resetListConfiguration() -
getParagraphCount
public int getParagraphCount() -
increaseParagraphCount
public void increaseParagraphCount()
-