com.jidesoft.editor.status
Interface CodeEditorStatusBarItem

All Known Implementing Classes:

AbstractCodeEditorStatusBarItem, CaretModelPositionStatusBarItem, CaretOffsetStatusBarItem, CaretOverwriteStatusBarItem, CaretStatusBarItem, CaretViewPositionStatusBarItem, EditableStatusBarItem, LineBreakStatusBarItem

public interface CodeEditorStatusBarItem

An interface of any StatusBarItem for CodeEditor.

Method Summary

CodeEditor	getCodeEditor() Gets the code editor.
void	initialize() Initializes the status bar item.
void	registerListener(CodeEditor editor) Status bar item needs to keep track of a certain status in code editor.
void	setCodeEditor(CodeEditor editor) Sets the code editor.
void	unregisterListener(CodeEditor editor) Removes the listener you registered in registerListener(com.jidesoft.editor.CodeEditor).

Method Detail

getCodeEditor

CodeEditor getCodeEditor()

Gets the code editor.

Returns:

the code editor.

setCodeEditor

void setCodeEditor(CodeEditor editor)

Sets the code editor.

Parameters:

editor -

initialize

void initialize()

Initializes the status bar item. Usually you do things like set preferred width, set alignment etc in this method.

registerListener

void registerListener(CodeEditor editor)

Status bar item needs to keep track of a certain status in code editor. So you should use this method to register a kind of listener to editor so that you can get notified when status changes. You should also update the current status and display on the status bar item.

For example, if this is a caret position status bar item, you should add CaretListener to the editor. And you should also retrive current caret position and display it.

Parameters:

editor -

unregisterListener

void unregisterListener(CodeEditor editor)

Removes the listener you registered in registerListener(com.jidesoft.editor.CodeEditor).

Parameters:

editor -