Package org.exbin.bined.capability

Interface ScrollingCapable

@ParametersAreNonnullByDefault
public interface ScrollingCapable

Support for scrolling capability.

Method Summary

Modifier and Type	Method	Description
void	addScrollingListener(ScrollingListener scrollingListener)	Adds scrolling listener.
void	centerOnCursor()	Scrolls scrolling area as centered as possible for current cursor position.
void	centerOnPosition(CodeAreaCaretPosition caretPosition)	Scrolls scrolling area as centered as possible for given caret position.
CodeAreaScrollPosition	computeScrolling(CodeAreaScrollPosition startPosition, ScrollingDirection direction)	Computes scrolling position for given direction.
CodeAreaScrollPosition	getScrollPosition()	Returns current scrolling position.
void	removeScrollingListener(ScrollingListener scrollingListener)	Removes scrolling listener.
void	revealCursor()	Reveals scrolling area for current cursor position.
void	revealPosition(CodeAreaCaretPosition caretPosition)	Reveals scrolling area for given caret position.
void	setScrollPosition(CodeAreaScrollPosition scrollPosition)	Sets current scrolling position.

Method Detail

getScrollPosition

@Nonnull
CodeAreaScrollPosition getScrollPosition()

Returns current scrolling position.

Returns:

scroll position

setScrollPosition

void setScrollPosition(CodeAreaScrollPosition scrollPosition)

Sets current scrolling position.

Parameters:

scrollPosition - scrolling position

addScrollingListener

void addScrollingListener(ScrollingListener scrollingListener)

Adds scrolling listener.

Parameters:

scrollingListener - scrolling listener

removeScrollingListener

void removeScrollingListener(ScrollingListener scrollingListener)

Removes scrolling listener.

Parameters:

scrollingListener - scrolling listener

computeScrolling

@Nonnull
CodeAreaScrollPosition computeScrolling(CodeAreaScrollPosition startPosition,
                                        ScrollingDirection direction)

Computes scrolling position for given direction.

Parameters:

startPosition - start position

direction - scrolling direction

Returns:

scrolling position

revealCursor

void revealCursor()

Reveals scrolling area for current cursor position.

revealPosition

void revealPosition(CodeAreaCaretPosition caretPosition)

Reveals scrolling area for given caret position.

Parameters:

caretPosition - caret position

centerOnCursor

void centerOnCursor()

Scrolls scrolling area as centered as possible for current cursor position.

centerOnPosition

void centerOnPosition(CodeAreaCaretPosition caretPosition)

Scrolls scrolling area as centered as possible for given caret position.

Parameters:

caretPosition - caret position