Package com.ms.ui

Previous

Contents

Index

Next

Interface IUIScroll

public interface IUIScroll 
{
  // Methods
  public int getScrollLine();
  public int getScrollMax();
  public int getScrollMin();
  public int getScrollPage();
  public int getScrollPos();

  public int setScrollInfo(int min, int max, int page, int line, int pos);
  public int setScrollLine(int line);
  public int setScrollMax(int max);
  public int setScrollMin(int min);
  public int setScrollPage(int page);
  public int setScrollPos(int pos);
  public int setScrollRange(int min, int max);

  public int scrollHome();
  public int scrollEnd();
  public int scrollLineUp();
  public int scrollLineDown();
  public int scrollPageUp();
  public int scrollPageDown();

  public boolean isScrollable();

}

Defines an interface for classes that can scroll within a range. UIScroll implements this interface.

Methods

getScrollLine

public int getScrollLine();

Retrieves the number of pixels associated with a scroll position.

Return Value:

Returns the number of pixels in a scroll line.

getScrollMax

public int getScrollMax();

Retrieves the maximum value in the object's range.

Return Value:

Returns the maximum range value (in pixels).

getScrollMin

public int getScrollMin();

Retrieves the minimum value in the object's range.

Return Value:

Returns the minimum range value (in pixels).

getScrollPage

public int getScrollPage();

Retrieves the number of scroll positions in a page.

Return Value:

Returns the number of scroll positions.

getScrollPos

public int getScrollPos();

Retrieves the object's current position.

Return Value:

Returns the current position (in pixels).

isScrollable

public boolean isScrollable();

Determines the current scrollable state of the object.

Return Value:

Returns true if the object is scrollable; otherwise, returns false.

scrollEnd

public int scrollEnd();

Moves the scroll position to the maximum range value.

Return Value:

Returns the new scroll position, based on the new scroll settings.

scrollHome

public int scrollHome();

Moves the scroll position to the minimum range value.

Return Value:

Returns the new scroll position, based on the new scroll settings.

scrollLineDown

public int scrollLineDown();

Moves the scroll position down (or right) by one line.

Return Value:

Returns the new scroll position, based on the new scroll settings.

scrollLineUp

public int scrollLineUp()

Moves the scroll position up (or left) by one line.

Return Value:

Returns the new scroll position, based on the new scroll settings.

scrollPageDown

public int scrollPageDown();

Moves the scroll position down (or right) by one line less than a full page.

Return Value:

Returns the new scroll position, based on the new scroll settings.

scrollPageUp

public int scrollPageUp();

Moves the scroll position up (or left) by one line less than a full page.

Return Value:

Returns the new scroll position, based on the new scroll settings.

setScrollInfo

public int setScrollInfo(int min, int max, int page, int line, int pos);

Sets the object's metrics with the specified values.

Return Value:

Returns the new scroll position, based on the new scroll settings.

Parameter	Description
min	The minimum value (in pixels) in the scroll range.
max	The maximum value (in pixels) in the scroll range.
page	The number of scroll positions associated with a full page.
line	The number of pixels associated with a scroll position.
pos	The current position inside the scroll range.

setScrollLine

public int setScrollLine(int line);

Sets the number of pixels associated with a scroll position.

Return Value:

Returns the new scroll position, based on the new scroll settings.

Parameter	Description
line	The number of pixels associated with a scroll position.

setScrollMax

public int setScrollMax(int max);

Sets the maximum value in the scroll range.

Return Value:

Returns the new scroll position, based on the new scroll settings.

Parameter	Description
max	The maximum value (in pixels) in the scroll range.

setScrollMin

public int setScrollMin(int min);

Sets the minimum value in the scroll range.

Return Value:

Returns the new scroll position, based on the new scroll settings.

Parameter	Description
min	The minimum value (in pixels) in the scroll range.

setScrollPage

public int setScrollPage(int page);

Sets the number of scroll positions in a page.

Return Value:

Returns the new scroll position, based on the new scroll settings.

Parameter	Description
page	The number of scroll positions associated with a full page.

setScrollPos

public int setScrollPos(int pos);

Sets the current position of the object.

Return Value:

Returns the new scroll position.

Parameter	Description
pos	The requested position within the scroll range.

setScrollRange

public int setScrollRange(int min, int max);

Sets both minimum and maximum values in the scroll range.

Return Value:

Returns the new scroll position, based on the new scroll settings.

Parameter	Description
min	The minimum value (in pixels) in the scroll range.
max	The maximum value (in pixels) in the scroll range.