Interface IUIScroll

public interface IUIScroll
{
  // Methods
  public int getScrollLine();
  public int getScrollMax();
  public int getScrollMin();
  public int getScrollPage();
  public int getScrollPos();
  public boolean isScrollable();
  public int scrollEnd();
  public int scrollHome();
  public int scrollLineDown();
  public int scrollLineUp();
  public int scrollPageDown();
  public int scrollPageUp();
  public int setScrollInfo(int min, int max, int page, int line,
        int pos);
  public void setScrollLine(int line);
  public void setScrollMax(int max);
  public void setScrollMin(int min);
  public void setScrollPage(int page);
  public void setScrollPos(int pos);
  public int setScrollRange(int min, int max);
}

This interface defines methods for scrolling within a range. UIScroll implements IUIScroll.

Methods

getScrollLine

public int getScrollLine();

Retrieves the number of scroll positions associated with a line.

Return Value:

Returns the number of scroll positions in a line.

Remarks:

For more information about line values, see the UIScroll overview.

getScrollMax

public int getScrollMax();

Retrieves the maximum value in the object's range.

Return Value:

Returns the maximum scroll position.

getScrollMin

public int getScrollMin();

Retrieves the minimum value in the object's range.

Return Value:

Returns the minimum scroll position.

getScrollPage

public int getScrollPage();

Retrieves the number of scroll positions associated with a page.

Return Value:

Returns the number of scroll positions in a page.

Remarks:

For more information about page values, see the UIScroll overview.

getScrollPos

public int getScrollPos();

Retrieves the position of the object.

Return Value:

Returns the current scroll position.

isScrollable

public boolean isScrollable();

Determines whether the object supports scrolling, based on its range and page values.

Return Value:

Returns true if the object must scroll; otherwise, returns false if scrolling is unnecessary.

scrollEnd

public int scrollEnd();

Moves the current scroll position to the maximum range value.

Return Value:

Returns the object's new scroll position.

scrollHome

public int scrollHome();

Moves the current scroll position to the minimum range value.

Return Value:

Returns the object's new scroll position.

scrollLineDown

public int scrollLineDown();

Increments the current scroll position by one line.

Return Value:

Returns the object's new scroll position.

Remarks:

For more information about line values, see the UIScroll overview.

scrollLineUp

public int scrollLineUp();

Decrements the current scroll position by one line.

Return Value:

Returns the object's new scroll position.

Remarks:

For more information about line values, see the UIScroll overview.

scrollPageDown

public int scrollPageDown();

Increments the current scroll position by one line less than a full page.

Return Value:

Returns the object's new scroll position.

Remarks:

For more information about page and line values, see the UIScroll overview.

scrollPageUp

public int scrollPageUp();

Decrements the current scroll position by one line less than a full page.

Return Value:

Returns the object's new scroll position.

Remarks:

For more information about page and line values, see the UIScroll overview.

setScrollInfo

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

Sets the specified scroll information and adjusts the object's current position accordingly.

Return Value:

Returns the object's new scroll position after setting the specified values.

Parameter	Description
min	The minimum scroll position in the object's range.
max	The maximum scroll position in the object's range.
page	The number of scroll positions associated with a page.
line	The number of scroll positions associated with a line.
pos	The current scroll position.

Remarks:

For more information about range, page, and line values, see the UIScroll overview.

setScrollLine

public void setScrollLine(int line);

Sets the number of scroll positions associated with a line and adjusts the object's current position accordingly.

Return Value:

No return value.

Parameter	Description
line	The number of scroll positions to be associated with a line.

Remarks:

For more information about line values, see the UIScroll overview.

setScrollMax

public void setScrollMax(int max);

Sets the maximum range value and adjusts the object's current position accordingly.

Return Value:

No return value.

Parameter	Description
max	The maximum scroll position.

setScrollMin

public void setScrollMin(int min);

Sets the minimum range value and adjusts the object's current position accordingly.

Return Value:

No return value.

Parameter	Description
min	The minimum scroll position.

setScrollPage

public void setScrollPage(int page);

Sets the number of scroll positions associated with a page and adjusts the object's current position accordingly.

Return Value:

No return value.

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

Remarks:

For more information about page values, see the UIScroll overview.

setScrollPos

public void setScrollPos(int pos);

Sets the object's current position to the specified scroll position.

Return Value:

No return value.

Parameter	Description
pos	The position for the object.

Remarks:

Depending on the object's range, the returned position may differ from the pos parameter.

setScrollRange

public int setScrollRange(int min, int max);

Sets the scroll track object's range and adjusts the object's current position accordingly.

Return Value:

Returns the object's new scroll position after setting the specified values.

Parameter	Description
min	The minimum scroll position.
max	The maximum scroll position.