CodeEditorDefaults (jEditor API)

java.lang.Object
- org.jeditor.core.CodeEditorDefaults

```
public class CodeEditorDefaults
extends java.lang.Object
```
Encapsulates default settings for a text area. This can be passed to the constructor once the necessary fields have been filled out. The advantage of doing this over calling lots of set() methods after creating the text area is that this method is faster.

Field Summary

Fields
Modifier and Type	Field and Description
`java.awt.Color`	`anchorMarkColor`
`boolean`	`blockCaret`
`boolean`	`bracketHighlight` True if associated start / end brackets is presented.
`java.awt.Color`	`bracketHighlightColor` The associated start / end brackets color.
`boolean`	`caretBlinks` True if the caret is blinking.
`java.awt.Color`	`caretColor` The Caret color.
`java.awt.Color`	`caretMarkColor`
`boolean`	`caretVisible` True if the caret is visible.
`int`	`cols` The number of columns of the editor.
`SyntaxDocument`	`document`
`boolean`	`editable` True if the document is editable.
`int`	`electricScroll`
`java.awt.Color`	`eolMarkerColor` The end of line markers color.
`boolean`	`eolMarkers` True if end of lines markers are visible.
`java.awt.Font`	`font` The document Font.
`java.awt.Color`	`gutterBgColor` The gutter background color.
`java.awt.Color`	`gutterBorderColor` The gutter border color.
`int`	`gutterBorderWidth` The gutter border width.
`boolean`	`gutterCollapsed` True if the gutter is collapsed.
`boolean`	`gutterExpandable` True if the gutter can be expanded or collapsed.
`java.awt.Color`	`gutterFgColor` The gutter foreground color.
`java.awt.Font`	`gutterFont` The gutter font.
`java.awt.Color`	`gutterHighlightColor` The gutter highlight color.
`int`	`gutterNumberAlignment` The gutter number alignment.
`int`	`gutterWidth` The gutter width.
`boolean`	`hasPopup` Specifies if there is a popup which should appear for right-clicking in the editor area.
`InputHandler`	`inputHandler`
`boolean`	`lineHighlight` True line highlighting is presented.
`java.awt.Color`	`lineHighlightColor` The line highlight color.
`boolean`	`paintInvalid`
`int`	`rows` The number of rows of the editor.
`java.awt.Color`	`selectionColor` The selection color.
`java.awt.Color`	`selectionMarkColor`
`SyntaxStyle[]`	`styles`
`int`	`tabSize` The tabulation size.

Constructor Summary

Constructors
Constructor and Description

CodeEditorDefaults()

CodeEditorDefaults(CodeEditorDefaults defaults)

Constructors
Constructor and Description
`CodeEditorDefaults()`
`CodeEditorDefaults(CodeEditorDefaults defaults)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addGutter()` Set the gutter as visible and make it expandable.
`static java.awt.Color`	`copyColor(java.awt.Color color)` Copy a color value.
`static java.awt.Font`	`copyFont(java.awt.Font font)` Copy a font value.
`static CodeEditorDefaults`	`getDefaults()` Returns a new CodeEditorDefaults object with the default values filled in.
`javax.swing.JPopupMenu`	`getPopup()` Return the popup which will be used when right-clicking on the editor.
`void`	`removeGutter()` Remove the gutter and make it not expandable.
`void`	`setPopup(javax.swing.JPopupMenu popup)` Set the popup which will be used when rightt-clicking on the editor.
`void`	`setStyle(byte keyword, java.awt.Color color, boolean italic, boolean bold)` Set a style for a Token.

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

- Field Detail
  - inputHandler
```
public InputHandler inputHandler
```
  - document
```
public SyntaxDocument document
```
  - editable
```
public boolean editable
```
    True if the document is editable.
  - caretVisible
```
public boolean caretVisible
```
    True if the caret is visible.
  - caretBlinks
```
public boolean caretBlinks
```
    True if the caret is blinking.
  - blockCaret
```
public boolean blockCaret
```
  - electricScroll
```
public int electricScroll
```
  - gutterCollapsed
```
public boolean gutterCollapsed
```
    True if the gutter is collapsed.
  - gutterExpandable
```
public boolean gutterExpandable
```
    True if the gutter can be expanded or collapsed.
  - gutterWidth
```
public int gutterWidth
```
    The gutter width.
  - gutterBgColor
```
public java.awt.Color gutterBgColor
```
    The gutter background color.
  - gutterFgColor
```
public java.awt.Color gutterFgColor
```
    The gutter foreground color.
  - gutterHighlightColor
```
public java.awt.Color gutterHighlightColor
```
    The gutter highlight color.
  - gutterBorderColor
```
public java.awt.Color gutterBorderColor
```
    The gutter border color.
  - gutterBorderWidth
```
public int gutterBorderWidth
```
    The gutter border width.
  - gutterNumberAlignment
```
public int gutterNumberAlignment
```
    The gutter number alignment. The supported values are:
    - SwingConstants.LEFT
    - SwingConstants.CENTER
    - SwingConstants.RIGHT
  - gutterFont
```
public java.awt.Font gutterFont
```
    The gutter font.
  - caretMarkColor
```
public java.awt.Color caretMarkColor
```
  - anchorMarkColor
```
public java.awt.Color anchorMarkColor
```
  - selectionMarkColor
```
public java.awt.Color selectionMarkColor
```
  - cols
```
public int cols
```
    The number of columns of the editor.
  - rows
```
public int rows
```
    The number of rows of the editor.
  - styles
```
public SyntaxStyle[] styles
```
  - font
```
public java.awt.Font font
```
    The document Font.
  - caretColor
```
public java.awt.Color caretColor
```
    The Caret color.
  - selectionColor
```
public java.awt.Color selectionColor
```
    The selection color.
  - lineHighlightColor
```
public java.awt.Color lineHighlightColor
```
    The line highlight color.
  - lineHighlight
```
public boolean lineHighlight
```
    True line highlighting is presented.
  - bracketHighlightColor
```
public java.awt.Color bracketHighlightColor
```
    The associated start / end brackets color.
  - bracketHighlight
```
public boolean bracketHighlight
```
    True if associated start / end brackets is presented.
  - eolMarkerColor
```
public java.awt.Color eolMarkerColor
```
    The end of line markers color.
  - eolMarkers
```
public boolean eolMarkers
```
    True if end of lines markers are visible.
  - paintInvalid
```
public boolean paintInvalid
```
  - tabSize
```
public int tabSize
```
    The tabulation size.
  - hasPopup
```
public boolean hasPopup
```
    Specifies if there is a popup which should appear for right-clicking in the editor area.
- Constructor Detail
  - CodeEditorDefaults
```
public CodeEditorDefaults()
```
  - CodeEditorDefaults
```
public CodeEditorDefaults(CodeEditorDefaults defaults)
```
- Method Detail
  - getDefaults
```
public static CodeEditorDefaults getDefaults()
```
    Returns a new CodeEditorDefaults object with the default values filled in.
    
    Returns:
    
    the CodeEditorDefaults
  - removeGutter
```
public void removeGutter()
```
    Remove the gutter and make it not expandable.
    
    See Also:
    
    addGutter()
  - addGutter
```
public void addGutter()
```
    Set the gutter as visible and make it expandable.
    
    See Also:
    
    removeGutter()
  - setPopup
```
public void setPopup(javax.swing.JPopupMenu popup)
```
    Set the popup which will be used when rightt-clicking on the editor.
    
    Parameters:
    
    popup - the popup
  - getPopup
```
public javax.swing.JPopupMenu getPopup()
```
    Return the popup which will be used when right-clicking on the editor.
    
    Returns:
    
    the popup
  - setStyle
```
public void setStyle(byte keyword,
                     java.awt.Color color,
                     boolean italic,
                     boolean bold)
```
    Set a style for a Token.
    
    Parameters:
    
    keyword - the Token id
    
    color - the color
    
    italic - true if the text should be in italic
    
    bold - true if the text should be in bold
  - copyColor
```
public static java.awt.Color copyColor(java.awt.Color color)
```
    Copy a color value.
    
    Parameters:
    
    color - the color
    
    Returns:
    
    the copied color
  - copyFont
```
public static java.awt.Font copyFont(java.awt.Font font)
```
    Copy a font value.
    
    Parameters:
    
    font - the font
    
    Returns:
    
    the copied font

Class CodeEditorDefaults

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

inputHandler

document

editable

caretVisible

caretBlinks

blockCaret

electricScroll

gutterCollapsed

gutterExpandable

gutterWidth

gutterBgColor

gutterFgColor

gutterHighlightColor

gutterBorderColor

gutterBorderWidth

gutterNumberAlignment

gutterFont

caretMarkColor

anchorMarkColor

selectionMarkColor

cols

rows

styles

font

caretColor

selectionColor

lineHighlightColor

lineHighlight

bracketHighlightColor

bracketHighlight

eolMarkerColor

eolMarkers

paintInvalid

tabSize

hasPopup

Constructor Detail

CodeEditorDefaults

CodeEditorDefaults

Method Detail

getDefaults

removeGutter

addGutter

setPopup

getPopup

setStyle

copyColor

copyFont