Package com.intellij.ide.todo

Class TodoConfiguration

java.lang.Object

com.intellij.ide.todo.TodoConfiguration

All Implemented Interfaces:

PersistentStateComponent<Element>

public class TodoConfiguration
extends java.lang.Object
implements PersistentStateComponent<Element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_MULTILINE
static java.lang.String	PROP_TODO_FILTERS
static java.lang.String	PROP_TODO_PATTERNS
static Topic<java.beans.PropertyChangeListener>	PROPERTY_CHANGE

Constructor Summary

Constructors

Constructor and Description
TodoConfiguration()

Method Summary

Modifier and Type	Method and Description
void	colorSettingsChanged()
protected TodoPattern []	getDefaultPatterns() Returns the list of default TO_DO patterns.
IndexPattern []	getIndexPatterns()
static TodoConfiguration	getInstance()
Element	getState()
TodoFilter	getTodoFilter(java.lang.String name)
TodoFilter []	getTodoFilters()
TodoPattern []	getTodoPatterns()
boolean	isMultiLine()
void	loadState(Element element) This method is called when new component state is loaded.
void	resetToDefaultTodoPatterns()
void	setMultiLine(boolean multiLine)
void	setTodoFilters(TodoFilter [] filters)
void	setTodoPatterns(TodoPattern [] todoPatterns)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intellij.openapi.components.PersistentStateComponent

initializeComponent, noStateLoaded

Field Detail

PROPERTY_CHANGE

public static final Topic<java.beans.PropertyChangeListener> PROPERTY_CHANGE

PROP_MULTILINE

public static final java.lang.String PROP_MULTILINE

See Also:

Constant Field Values

PROP_TODO_PATTERNS

public static final java.lang.String PROP_TODO_PATTERNS

See Also:

Constant Field Values

PROP_TODO_FILTERS

public static final java.lang.String PROP_TODO_FILTERS

See Also:

Constant Field Values

Constructor Detail

TodoConfiguration

public TodoConfiguration()

Method Detail

getInstance

public static TodoConfiguration getInstance()

resetToDefaultTodoPatterns

public void resetToDefaultTodoPatterns()

getDefaultPatterns

protected TodoPattern [] getDefaultPatterns()

Returns the list of default TO_DO patterns. Can be customized in other IDEs (and is customized in Rider).

getTodoPatterns

public TodoPattern [] getTodoPatterns()

getIndexPatterns

public IndexPattern [] getIndexPatterns()

setTodoPatterns

public void setTodoPatterns(TodoPattern [] todoPatterns)

getTodoFilter

public TodoFilter getTodoFilter(java.lang.String name)

Returns:

TodoFilter with specified name. Method returns null if there is no filter with name.

getTodoFilters

public TodoFilter [] getTodoFilters()

Returns:

all TodoFilters.

isMultiLine

public boolean isMultiLine()

setMultiLine

public void setMultiLine(boolean multiLine)

setTodoFilters

public void setTodoFilters(TodoFilter [] filters)

loadState

public void loadState(Element element)

Description copied from interface: PersistentStateComponent

This method is called when new component state is loaded. The method can and will be called several times, if config files were externally changed while IDE was running.

State object should be used directly, defensive copying is not required.

Specified by:

loadState in interface PersistentStateComponent<Element>

Parameters:

element - loaded component state

See Also:

XmlSerializerUtil.copyBean(Object, Object)

getState

public Element getState()

Specified by:

getState in interface PersistentStateComponent<Element>

Returns:

a component state. All properties, public and annotated fields are serialized. Only values, which differ from the default (i.e., the value of newly instantiated class) are serialized. null value indicates that the returned state won't be stored, as a result previously stored state will be used.

See Also:

XmlSerializer

colorSettingsChanged

public void colorSettingsChanged()