com.swfm.mica.core
Interface MiiScrollableData

All Known Implementing Classes:

MiEditor, MiTable, MiVirtualTable, MiVirtualTreeTable

public interface MiiScrollableData

Version:

%I% %G%

Author:

Michael L. Davis

Method Summary

double	getNormalizedHorizontalAmountVisible() Gets the normalized (between 0.0 and 1.0 inclusive) horizontal size of the data (0.0 indicates none of the data is visible and 1.0 indicates all of the data's width is visible).
double	getNormalizedHorizontalPosition() Gets the normalized (between 0.0 and 1.0 inclusive) horizontal position of the data (0.0 is the left side and 1.0 is the right side).
double	getNormalizedVerticalAmountVisible() Gets the normalized (between 0.0 and 1.0 inclusive) vertical size of the data (0.0 indicates none of the data is visible and 1.0 indicates all of the data's height is visible).
double	getNormalizedVerticalPosition() Gets the normalized (between 0.0 and 1.0 inclusive) vertical position of the data (0.0 is the left side and 1.0 is the right side).
boolean	isHandlingScrollingDiscreteAmountsLocally() Gets whether actions like scrollLineDown is handled in this interfaces implementation or whether these type of methods are merely to be notified of the scrolling calculated elsewhere and executed by calling scrollToNormalizedVerticalPosition.
void	scrollChunkDown() Scrolls one chunk down (conversely, move the data one chunk up).
void	scrollChunkLeft() Scrolls one chunk left (conversely, move the data one chunk right).
void	scrollChunkRight() Scrolls one chunk right (conversely, move the data one chunk left).
void	scrollChunkUp() Scrolls one chunk up (conversely, move the data one chunk down).
void	scrollLineDown() Scrolls one line down (conversely, move the data one line up).
void	scrollLineLeft() Scrolls one line left (conversely, move the data one line right).
void	scrollLineRight() Scrolls one line right (conversely, move the data one line left).
void	scrollLineUp() Scrolls one line up (conversely, move the data one line down).
void	scrollPageDown() Scrolls one page down (conversely, move the data one page up).
void	scrollPageLeft() Scrolls one page left (conversely, move the data one page right).
void	scrollPageRight() Scrolls one page right (conversely, move the data one page left).
void	scrollPageUp() Scrolls one page up (conversely, move the data one page down).
void	scrollToBottom() Scrolls to the bottom of the data.
void	scrollToLeftSide() Scrolls to the left side of the data.
void	scrollToNormalizedHorizontalPosition(double normalizedPosition) Scrolls to the given normalized (between 0.0 and 1.0) vertical position.
void	scrollToNormalizedVerticalPosition(double normalizedPosition) Scrolls to the given normalized (between 0.0 and 1.0) horizontal position.
void	scrollToRightSide() Scrolls to the right side of the data.
void	scrollToTop() Scrolls to the top of the data.

Method Detail

isHandlingScrollingDiscreteAmountsLocally

public boolean isHandlingScrollingDiscreteAmountsLocally()

Gets whether actions like scrollLineDown is handled in this interfaces implementation or whether these type of methods are merely to be notified of the scrolling calculated elsewhere and executed by calling scrollToNormalizedVerticalPosition.

Returns:

true if minor scrolling is implemented here

getNormalizedHorizontalPosition

public double getNormalizedHorizontalPosition()

Gets the normalized (between 0.0 and 1.0 inclusive) horizontal position of the data (0.0 is the left side and 1.0 is the right side).

Returns:

the horizontal position

getNormalizedVerticalPosition

public double getNormalizedVerticalPosition()

Gets the normalized (between 0.0 and 1.0 inclusive) vertical position of the data (0.0 is the left side and 1.0 is the right side).

Returns:

the vertical position

getNormalizedHorizontalAmountVisible

public double getNormalizedHorizontalAmountVisible()

Gets the normalized (between 0.0 and 1.0 inclusive) horizontal size of the data (0.0 indicates none of the data is visible and 1.0 indicates all of the data's width is visible).

Returns:

the amount of data visible

getNormalizedVerticalAmountVisible

public double getNormalizedVerticalAmountVisible()

Gets the normalized (between 0.0 and 1.0 inclusive) vertical size of the data (0.0 indicates none of the data is visible and 1.0 indicates all of the data's height is visible).

Returns:

the amount of data visible

scrollLineUp

public void scrollLineUp()

Scrolls one line up (conversely, move the data one line down). If already at the top of the data then this does nothing. It is up to the implementation of this interface to determine what a 'line' is.

scrollLineDown

public void scrollLineDown()

Scrolls one line down (conversely, move the data one line up). If already at the bottom of the data then this does nothing. It is up to the implementation of this interface to determine what a 'line' is.

scrollLineLeft

public void scrollLineLeft()

Scrolls one line left (conversely, move the data one line right). If already at the left of the data then this does nothing. It is up to the implementation of this interface to determine what a 'line' is.

scrollLineRight

public void scrollLineRight()

Scrolls one line right (conversely, move the data one line left). If already at the right of the data then this does nothing. It is up to the implementation of this interface to determine what a 'line' is.

scrollChunkUp

public void scrollChunkUp()

Scrolls one chunk up (conversely, move the data one chunk down). If already at the top of the data then this does nothing. It is up to the implementation of this interface to determine what a 'chunk' is.

scrollChunkDown

public void scrollChunkDown()

Scrolls one chunk down (conversely, move the data one chunk up). If already at the bottom of the data then this does nothing. It is up to the implementation of this interface to determine what a 'chunk' is.

scrollChunkLeft

public void scrollChunkLeft()

Scrolls one chunk left (conversely, move the data one chunk right). If already at the left of the data then this does nothing. It is up to the implementation of this interface to determine what a 'chunk' is.

scrollChunkRight

public void scrollChunkRight()

Scrolls one chunk right (conversely, move the data one chunk left). If already at the right of the data then this does nothing. It is up to the implementation of this interface to determine what a 'chunk' is.

scrollPageUp

public void scrollPageUp()

Scrolls one page up (conversely, move the data one page down). If already at the top of the data then this does nothing. It is up to the implementation of this interface to determine what a 'page' is.

scrollPageDown

public void scrollPageDown()

Scrolls one page down (conversely, move the data one page up). If already at the bottom of the data then this does nothing. It is up to the implementation of this interface to determine what a 'page' is.

scrollPageLeft

public void scrollPageLeft()

Scrolls one page left (conversely, move the data one page right). If already at the left of the data then this does nothing. It is up to the implementation of this interface to determine what a 'page' is.

scrollPageRight

public void scrollPageRight()

Scrolls one page right (conversely, move the data one page left). If already at the right of the data then this does nothing. It is up to the implementation of this interface to determine what a 'page' is.

scrollToTop

public void scrollToTop()

Scrolls to the top of the data.

scrollToBottom

public void scrollToBottom()

Scrolls to the bottom of the data.

scrollToLeftSide

public void scrollToLeftSide()

Scrolls to the left side of the data.

scrollToRightSide

public void scrollToRightSide()

Scrolls to the right side of the data.

scrollToNormalizedVerticalPosition

public void scrollToNormalizedVerticalPosition(double normalizedPosition)

Scrolls to the given normalized (between 0.0 and 1.0) horizontal position.

Parameters:

normalizedPosition - the new horizontal position

scrollToNormalizedHorizontalPosition

public void scrollToNormalizedHorizontalPosition(double normalizedPosition)

Scrolls to the given normalized (between 0.0 and 1.0) vertical position.

Parameters:

normalizedPosition - the new vertical position