Theme (Java Prettify 2.0.1 API)

java.lang.Object
- syntaxhighlight.Theme

Direct Known Subclasses:

ThemeDefault, ThemeDesert, ThemeSonsOfObsidian, ThemeSunburst
```
public class Theme
extends Object
```
Theme for the SyntaxHighlighterPane and JTextComponentRowHeader. To make a new theme, either extending this class or initiate this class and set parameters using setters. For the default value, find the comment of the constructor.

Author:

Chan Wai Shing

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`background` The background color of the script text area.
`protected Font`	`font` The font of the script text.
`protected Color`	`gutterBorderColor` The color of the border that joint the gutter and the script text area.
`protected int`	`gutterBorderWidth` The width of the border that joint the gutter and the script text area.
`protected Color`	`gutterText` The color of the gutter text.
`protected Font`	`gutterTextFont` The font of the gutter text.
`protected int`	`gutterTextPaddingLeft` The minimum padding from 'the leftmost of the line number text' to 'the left margin'.
`protected int`	`gutterTextPaddingRight` The minimum padding from 'the rightmost of the line number text' to 'the right margin' (not to the gutter border).
`protected Color`	`highlightedBackground` The background color of the highlighted line of script text.
`protected Style`	`plain` The default style.
`protected Map<String,Style>`	`styles` The styles of this theme.

Constructor Summary

Constructors
Constructor and Description

Theme()
Constructor.

Constructors
Constructor and Description
`Theme()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Style`	`addStyle(String styleKey, Style style)` Add style.
`void`	`clearStyles()` Clear all styles.
`Theme`	`clone()`
`Color`	`getBackground()` The background color of the script text area.
`Font`	`getFont()` The font of the script text.
`Color`	`getGutterBorderColor()` The color of the border that joint the gutter and the script text area.
`int`	`getGutterBorderWidth()` The width of the border that joint the gutter and the script text area.
`Color`	`getGutterText()` The color of the gutter text.
`Font`	`getGutterTextFont()` The font of the gutter text.
`int`	`getGutterTextPaddingLeft()` The minimum padding from 'the leftmost of the line number text' to 'the left margin'.
`int`	`getGutterTextPaddingRight()` The minimum padding from 'the rightmost of the line number text' to 'the right margin' (not to the gutter border).
`Color`	`getHighlightedBackground()` The background color of the highlighted line of script text.
`Style`	`getPlain()` Get the default style.
`Style`	`getStyle(String key)` Get the style by keyword.
`Map<String,Style>`	`getStyles()` Get all styles.
`SimpleAttributeSet`	`getStylesAttributeSet(String styleKeys)` Get the `AttributeSet` of `styleKeys`.
`Style`	`removeStyle(String styleKey)` Remove style by keyword.
`void`	`setBackground(Color background)` The background color of the script text area.
`void`	`setFont(Font font)` The font of the script text.
`void`	`setGutterBorderColor(Color gutterBorderColor)` The color of the border that joint the gutter and the script text area.
`void`	`setGutterBorderWidth(int gutterBorderWidth)` The width of the border that joint the gutter and the script text area.
`void`	`setGutterText(Color gutterText)` The color of the gutter text.
`void`	`setGutterTextFont(Font gutterTextFont)` The font of the gutter text.
`void`	`setGutterTextPaddingLeft(int gutterTextPaddingLeft)` The minimum padding from 'the leftmost of the line number text' to 'the left margin'.
`void`	`setGutterTextPaddingRight(int gutterTextPaddingRight)` The minimum padding from 'the rightmost of the line number text' to 'the right margin' (not to the gutter border).
`void`	`setHighlightedBackground(Color highlightedBackground)` The background color of the highlighted line of script text.
`void`	`setPlain(Style plain)` Set the default style.
`void`	`setTheme(JTextComponentRowHeader rowHeader)` Apply the theme to the row header panel.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - font
```
protected Font font
```
    The font of the script text.
  - background
```
protected Color background
```
    The background color of the script text area.
  - highlightedBackground
```
protected Color highlightedBackground
```
    The background color of the highlighted line of script text.
  - gutterText
```
protected Color gutterText
```
    The color of the gutter text.
  - gutterBorderColor
```
protected Color gutterBorderColor
```
    The color of the border that joint the gutter and the script text area.
  - gutterBorderWidth
```
protected int gutterBorderWidth
```
    The width of the border that joint the gutter and the script text area.
  - gutterTextFont
```
protected Font gutterTextFont
```
    The font of the gutter text.
  - gutterTextPaddingLeft
```
protected int gutterTextPaddingLeft
```
    The minimum padding from 'the leftmost of the line number text' to 'the left margin'.
  - gutterTextPaddingRight
```
protected int gutterTextPaddingRight
```
    The minimum padding from 'the rightmost of the line number text' to 'the right margin' (not to the gutter border).
  - plain
```
protected Style plain
```
    The default style. When the style requested by getStyle(String) not exist, this will be returned.
  - styles
```
protected Map<String,Style> styles
```
    The styles of this theme.
- Constructor Detail
  - Theme
```
public Theme()
```
    Constructor.
    
    Default value:
    - font: Consolas 12pt
    - background: white
    - gutter text: black
    - gutter border: R: 184, G: 184, B: 184
    - gutter border width: 3px
    - gutter text font: Consolas 12pt
    - gutter text padding-left: 7px
    - gutter text padding-right: 7px
- Method Detail
  - setTheme
```
public void setTheme(JTextComponentRowHeader rowHeader)
```
    Apply the theme to the row header panel.
    
    Parameters:
    
    rowHeader - the row header to apply the theme on
  - setPlain
```
public void setPlain(Style plain)
```
    Set the default style.
    
    Parameters:
    
    plain - the style
  - getPlain
```
public Style getPlain()
```
    Get the default style.
    
    Returns:
    
    the style
  - getStylesAttributeSet
```
public SimpleAttributeSet getStylesAttributeSet(String styleKeys)
```
    Get the AttributeSet of styleKeys. For more than one styles, separate the styles by space, e.g. 'plain comments'.
    
    Parameters:
    
    styleKeys - the style keys with keys separated by space
    
    Returns:
    
    the combined AttributeSet
  - addStyle
```
public Style addStyle(String styleKey,
                      Style style)
```
    Add style.
    
    Parameters:
    
    styleKey - the keyword of the style
    
    style - the style
    
    Returns:
    
    see the return value of Map.put(Object, Object)
  - removeStyle
```
public Style removeStyle(String styleKey)
```
    Remove style by keyword.
    
    Parameters:
    
    styleKey - the keyword of the style
    
    Returns:
    
    see the return value of Map.remove(Object)
  - getStyle
```
public Style getStyle(String key)
```
    Get the style by keyword.
    
    Parameters:
    
    key - the keyword
    
    Returns:
    
    the syntaxhighlighter.theme.Style related to the key; if the style related to the key not exist, the style of 'plain' will return.
  - getStyles
```
public Map<String,Style> getStyles()
```
    Get all styles.
    
    Returns:
    
    the styles
  - clearStyles
```
public void clearStyles()
```
    Clear all styles.
  - getFont
```
public Font getFont()
```
    The font of the script text.
    
    Returns:
    
    the font
  - setFont
```
public void setFont(Font font)
```
    The font of the script text.
    
    Parameters:
    
    font - the font
  - getBackground
```
public Color getBackground()
```
    The background color of the script text area.
    
    Returns:
    
    the color
  - setBackground
```
public void setBackground(Color background)
```
    The background color of the script text area.
    
    Parameters:
    
    background - the color
  - getHighlightedBackground
```
public Color getHighlightedBackground()
```
    The background color of the highlighted line of script text.
    
    Returns:
    
    the color
  - setHighlightedBackground
```
public void setHighlightedBackground(Color highlightedBackground)
```
    The background color of the highlighted line of script text.
    
    Parameters:
    
    highlightedBackground - the color
  - getGutterText
```
public Color getGutterText()
```
    The color of the gutter text.
    
    Returns:
    
    the color
  - setGutterText
```
public void setGutterText(Color gutterText)
```
    The color of the gutter text.
    
    Parameters:
    
    gutterText - the color
  - getGutterBorderColor
```
public Color getGutterBorderColor()
```
    The color of the border that joint the gutter and the script text area.
    
    Returns:
    
    the color
  - setGutterBorderColor
```
public void setGutterBorderColor(Color gutterBorderColor)
```
    The color of the border that joint the gutter and the script text area.
    
    Parameters:
    
    gutterBorderColor - the color
  - getGutterBorderWidth
```
public int getGutterBorderWidth()
```
    The width of the border that joint the gutter and the script text area.
    
    Returns:
    
    the width in pixel
  - setGutterBorderWidth
```
public void setGutterBorderWidth(int gutterBorderWidth)
```
    The width of the border that joint the gutter and the script text area.
    
    Parameters:
    
    gutterBorderWidth - in pixel
  - getGutterTextFont
```
public Font getGutterTextFont()
```
    The font of the gutter text.
    
    Returns:
    
    the font
  - setGutterTextFont
```
public void setGutterTextFont(Font gutterTextFont)
```
    The font of the gutter text.
    
    Parameters:
    
    gutterTextFont - the font
  - getGutterTextPaddingLeft
```
public int getGutterTextPaddingLeft()
```
    The minimum padding from 'the leftmost of the line number text' to 'the left margin'.
    
    Returns:
    
    the padding in pixel
  - setGutterTextPaddingLeft
```
public void setGutterTextPaddingLeft(int gutterTextPaddingLeft)
```
    The minimum padding from 'the leftmost of the line number text' to 'the left margin'.
    
    Parameters:
    
    gutterTextPaddingLeft - in pixel
  - getGutterTextPaddingRight
```
public int getGutterTextPaddingRight()
```
    The minimum padding from 'the rightmost of the line number text' to 'the right margin' (not to the gutter border).
    
    Returns:
    
    the padding in pixel
  - setGutterTextPaddingRight
```
public void setGutterTextPaddingRight(int gutterTextPaddingRight)
```
    The minimum padding from 'the rightmost of the line number text' to 'the right margin' (not to the gutter border).
    
    Parameters:
    
    gutterTextPaddingRight - in pixel
  - clone
```
public Theme clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Theme

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

font

background

highlightedBackground

gutterText

gutterBorderColor

gutterBorderWidth

gutterTextFont

gutterTextPaddingLeft

gutterTextPaddingRight

plain

styles

Constructor Detail

Theme

Method Detail

setTheme

setPlain

getPlain

getStylesAttributeSet

addStyle

removeStyle

getStyle

getStyles

clearStyles

getFont

setFont

getBackground

setBackground

getHighlightedBackground

setHighlightedBackground

getGutterText

setGutterText

getGutterBorderColor

setGutterBorderColor

getGutterBorderWidth

setGutterBorderWidth

getGutterTextFont

setGutterTextFont

getGutterTextPaddingLeft

setGutterTextPaddingLeft

getGutterTextPaddingRight

setGutterTextPaddingRight

clone

toString