java.lang.Object

jsyntaxpane.components.TokenMarker

All Implemented Interfaces:: PropertyChangeListener, EventListener, CaretListener, SyntaxComponent

public class TokenMarker extends Object implements SyntaxComponent, CaretListener, PropertyChangeListener

This class highlights Tokens within a document whenever the caret is moved to a TokenType provided in the config file.

Nested Class Summary

Nested classes/interfaces inherited from interface jsyntaxpane.components.SyntaxComponent
SyntaxComponent.Status
Field Summary

Fields

Modifier and Type

Field

Description

static final String

DEFAULT_TOKENTYPES

static final String

PROPERTY_COLOR

static final String

PROPERTY_TOKENTYPES
Constructor Summary

Constructors

Constructor

Description

TokenMarker()

Constructs a new Token highlighter
Method Summary

Modifier and Type

Method

Description

void

caretUpdate(CaretEvent e)

void

config(Configuration config)

Configure the component using the given properties.

void

deinstall(JEditorPane editor)

Called when the component is to be removed from the editor

void

install(JEditorPane editor)

Called to install the component on an editor

void

markTokenAt(int pos)

void

propertyChange(PropertyChangeEvent evt)

void

removeMarkers()

removes all markers from the pane.

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

Field Details
- DEFAULT_TOKENTYPES
  
  public static final String DEFAULT_TOKENTYPES
  See Also:
  
  Constant Field Values
- PROPERTY_COLOR
  
  public static final String PROPERTY_COLOR
  See Also:
  
  Constant Field Values
- PROPERTY_TOKENTYPES
  
  public static final String PROPERTY_TOKENTYPES
  See Also:
  
  Constant Field Values
Constructor Details
- TokenMarker
  
  public TokenMarker()
  
  Constructs a new Token highlighter
Method Details
- caretUpdate
  
  public void caretUpdate(CaretEvent e)
  
  Specified by:
  
  caretUpdate in interface CaretListener
- markTokenAt
  
  public void markTokenAt(int pos)
- removeMarkers
  
  public void removeMarkers()
  
  removes all markers from the pane.
- config
  
  public void config(Configuration config)
  
  Description copied from interface: SyntaxComponent
  
  Configure the component using the given properties. The keys needed for configuration will be prefixed by the given prefix
  
  Specified by:
  
  config in interface SyntaxComponent
  
  Parameters:
  
  config - configuration data
- install
  
  public void install(JEditorPane editor)
  
  Description copied from interface: SyntaxComponent
  
  Called to install the component on an editor
  
  Specified by:
  
  install in interface SyntaxComponent
- deinstall
  
  public void deinstall(JEditorPane editor)
  
  Description copied from interface: SyntaxComponent
  
  Called when the component is to be removed from the editor
  
  Specified by:
  
  deinstall in interface SyntaxComponent
- propertyChange
  
  public void propertyChange(PropertyChangeEvent evt)
  
  Specified by:
  
  propertyChange in interface PropertyChangeListener

Class TokenMarker

Nested Class Summary

Nested classes/interfaces inherited from interface jsyntaxpane.components.SyntaxComponent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

DEFAULT_TOKENTYPES

PROPERTY_COLOR

PROPERTY_TOKENTYPES

Constructor Details

TokenMarker

Method Details

caretUpdate

markTokenAt

removeMarkers

config

install

deinstall

propertyChange