public interface

Scrollable

com.microstrategy.web.objects.Scrollable
Known Indirect Subclasses

Class Overview

Generic interface representing scrollable collection.

Summary

Constants
int FIRST_BLOCK Constant for first block
int NEXT_BLOCK Constant for next block
int PREVIOUS_BLOCK Constant for previous block
Public Methods
abstract int getBlockPosition()
Returns current block's position
abstract int getBlockSize()
Returns the size of current block.
abstract void gotoBlock(int blockIndex)
Goto a certain block.
abstract boolean hasNextBlock()
Returns whether there is another block following this block.
abstract boolean hasPreviousBlock()
Returns whether there is another block before this block.
abstract void setBlockSize(int value)
Sets the block size.

Constants

public static final int FIRST_BLOCK

Constant for first block

Constant Value: -3 (0xfffffffd)

public static final int NEXT_BLOCK

Constant for next block

Constant Value: -1 (0xffffffff)

public static final int PREVIOUS_BLOCK

Constant for previous block

Constant Value: -2 (0xfffffffe)

Public Methods

public abstract int getBlockPosition ()

Returns current block's position

Returns
  • int The 1-based block position.
Throws
MSTRCheckedException Thrown when an error happened during the action.

public abstract int getBlockSize ()

Returns the size of current block.

Returns
  • int

public abstract void gotoBlock (int blockIndex)

Goto a certain block.

Parameters
blockIndex int When the value is negative number, it represents the named block FIRST_BLOCK, NEXT_BLOCK, PREVIOUS_BLOCK. When it is non-negative number, it indicates the 0-based absolute block index.
Throws
MSTRCheckedException Thrown if an error happended during the action.
IllegalArgumentException Thrown if the input argument is not a valid value.

public abstract boolean hasNextBlock ()

Returns whether there is another block following this block.

Returns
  • boolean Returns true when there is another block following. Returns false when this is the last block.
Throws
MSTRCheckedException Thrown if an error happened during this action.

public abstract boolean hasPreviousBlock ()

Returns whether there is another block before this block.

Returns
  • boolean Returns true when there is another block before this one. Returns false when this is the first block.
Throws
MSTRCheckedException Thrown if an error happened during this action.

public abstract void setBlockSize (int value)

Sets the block size. Each time when this method is called, the current block will reset to the first block.

Parameters
value int the new block size
Throws
MSTRCheckedException Thrown when error happens during setting this value.