org.netbeans.spi.editor.typinghooks

Class CamelCaseInterceptor.MutableContext

java.lang.Object

org.netbeans.spi.editor.typinghooks.CamelCaseInterceptor.MutableContext

Enclosing interface:

CamelCaseInterceptor

public static final class CamelCaseInterceptor.MutableContext
extends Object

The context class providing information about the edited document, its editor pane and the offset where the key event occurred.

Method Summary

Modifier and Type	Method and Description
JTextComponent	getComponent() Gets the editor component where the currently processed key typed event occurred.
Document	getDocument() Gets the edited document.
int	getOffset() Gets the offset.
boolean	isBackward() Determines the type of the direction performed by a user.
void	setNextWordOffset(int nextWordOffset) Sets the new offset after remove or jump.

Methods inherited from class java.lang.Object

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

Method Detail

getComponent

public JTextComponent getComponent()

Gets the editor component where the currently processed key typed event occurred.

Returns:

The editor pane that contains the edited Document.

getDocument

public Document getDocument()

Gets the edited document. It's the document, where the text will be removed.

Returns:

The edited document.

getOffset

public int getOffset()

Gets the offset. This is the offset in the document where a user performed the camel case action (ie. where the currently processed KeyEvent happened). This is also the offset with text, which will be removed or jumped.

Returns:

The offset in the edited document.

isBackward

public boolean isBackward()

Determines the type of the direction performed by a user. The two possible actions are called differently on different platforms, but they are always defined by the position of a character, which they are applied to. The backspace/left arrow action deletes/jumps a character on the left hand side of a caret, while the delete/right arrow action deletes/jumps a character on the right hand side of the caret.

In other words one delete action removes characters backwards moving the caret towards the beginning if a document and the other action leaves the caret at the same position and removes characters towards the end of the document.

Returns:

true if the interceptor is called to handle the backspace action. false if the handled action is the delete action.

setNextWordOffset

public void setNextWordOffset(int nextWordOffset)

Sets the new offset after remove or jump.

Parameters:

nextWordOffset - == -1 if default implementation should process otherwise nextWordOffset is used to jump/delete