org.netbeans.spi.editor.caret

Class CascadingNavigationFilter

java.lang.Object

javax.swing.text.NavigationFilter

org.netbeans.spi.editor.caret.CascadingNavigationFilter

public abstract class CascadingNavigationFilter
extends NavigationFilter

Boilerplate NavigationFilter, which supports chaining of filters on an JTextComponent.

The implementation should call super methods to allow lower-precedence filters to react. If the implementation desires to disable the filters and take the movement action directly, it can still use the FilterBypass instance passed.

There are helper CascadingNavigationFilter.register(javax.swing.text.JTextComponent, org.netbeans.api.editor.caret.MoveCaretsOrigin) and CascadingNavigationFilter.unregister() methods which ensure the chain of filters is correctly maintained. After registering, methods implemented by this class will delegate to the remembered formerly-toplevel filter. Implementor of this class may safely call super.* methods to delegate to filters further in the chain.

Since:

2.10

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.text.NavigationFilter

NavigationFilter.FilterBypass

Constructor Summary

Constructors

Constructor and Description
CascadingNavigationFilter()

Method Summary

Modifier and Type	Method and Description
protected NavigationFilter	getNextFilter() Returns the next filter in the chain.
int	getNextVisualPositionFrom(JTextComponent text, int pos, Position.Bias bias, int direction, Position.Bias[] biasRet)
void	moveDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
void	register(JTextComponent component, MoveCaretsOrigin origin) Registers this Filter into the NavigationFilter chain.
void	setDot(NavigationFilter.FilterBypass fb, int dot, Position.Bias bias)
void	setOwnerAndPrevious(JTextComponent component, MoveCaretsOrigin orig, NavigationFilter prev)
void	unregister() Removes this NavigationFilter from the chain; preceding filter will be connected to the following one, so the chain will not be broken.

Methods inherited from class java.lang.Object

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

Constructor Detail

CascadingNavigationFilter

public CascadingNavigationFilter()

Method Detail

getNextFilter

protected final NavigationFilter getNextFilter()

Returns the next filter in the chain. This class' implementations of NavigationFilter API methods delegate to that filter, if non-null. Results after this Filter is unregistered (removed from the NavigationFilter) chain are undefined.

Returns:

next NavigationFilter.

getNextVisualPositionFrom

public int getNextVisualPositionFrom(JTextComponent text,
                                     int pos,
                                     Position.Bias bias,
                                     int direction,
                                     Position.Bias[] biasRet)
                              throws BadLocationException

Overrides:

getNextVisualPositionFrom in class NavigationFilter

Throws:

BadLocationException

moveDot

public void moveDot(NavigationFilter.FilterBypass fb,
                    int dot,
                    Position.Bias bias)

Overrides:

moveDot in class NavigationFilter

setDot

public void setDot(NavigationFilter.FilterBypass fb,
                   int dot,
                   Position.Bias bias)

Overrides:

setDot in class NavigationFilter

unregister

public final void unregister()

Removes this NavigationFilter from the chain; preceding filter will be connected to the following one, so the chain will not be broken.

register

public final void register(@NonNull
                           JTextComponent component,
                           @NonNull
                           MoveCaretsOrigin origin)

Registers this Filter into the NavigationFilter chain.

This filter will be placed on top of the filter's chain and the formerly-toplevel filter will be remembered for delegation.

It is not permitted to register with more carets; make multiple instances of the filter for that case.

Parameters:

component - where this Filter should be registered.

origin - operation specifier

setOwnerAndPrevious

public void setOwnerAndPrevious(JTextComponent component,
                                MoveCaretsOrigin orig,
                                NavigationFilter prev)