ilog.views.gantt

Interface IlvVerticalScrollable

All Known Implementing Classes:

IlvGanttChart, IlvHierarchyChart, IlvJScrollGanttSheet, IlvJScrollPane, IlvScheduleChart, IlvVerticalBoundedRangeModel, IlvVerticalScrollController

public interface IlvVerticalScrollable

The IlvVerticalScrollable interface defines the behavior of a UI component that can be scrolled vertically. There are three interrelated integer properties: maxVerticalPosition, verticalPosition, and verticalExtent. These three values define two nested ranges like this:

  0 <= verticalPosition <= verticalPosition+verticalExtent <= maxVerticalPosition

The scrollable enforces this relationship by correcting or trimming properties according to the following rules:

• The setMaxVerticalPosition(int) method first validates that:

    0 <= maxVisibleTime 

  If not, an IllegalArgumentException is thrown. Next, the vertical position and extent properties may be trimmed (in that order), to fit within the new 0-max range.

• The setVerticalPosition(int) and setVerticalExtent(int) methods trim their argument to fit within the limits defined by the other two properties.

Method Summary

Modifier and Type	Method and Description
void	addVerticalScrollListener(VerticalScrollListener listener) Adds the specified listener to receive vertical scroll events from this scrollable.
int	getMaxVerticalPosition() Returns the maximum vertical position that the scrollable can display.
int	getVerticalExtent() Returns the extent of the vertical range displayed by the scrollable.
int	getVerticalPosition() Returns the beginning of the vertical range displayed by the scrollable.
void	removeVerticalScrollListener(VerticalScrollListener listener) Removes the specified listener so that it will no longer receive vertical scroll events from this scrollable.
void	setMaxVerticalPosition(int max) Sets the maximum vertical position that the scrollable can display.
void	setVerticalExtent(int extent) Sets the extent of the vertical range displayed by the scrollable.
void	setVerticalPosition(int position) Sets the beginning of the vertical range displayed by the scrollable.

Method Detail

getMaxVerticalPosition

int getMaxVerticalPosition()

Returns the maximum vertical position that the scrollable can display.

Returns:

The scrollable's maximum.

Since:

JViews 3.5

See Also:

setMaxVerticalPosition(int)

setMaxVerticalPosition

void setMaxVerticalPosition(int max)

Sets the maximum vertical position that the scrollable can display. The current vertical position and extent are trimmed to fit the new 0-max range. A maxVerticalPositionChanged event is then fired to all registered listeners. If max < 0 an IllegalArgumentException will be thrown.

Parameters:

max - The maximum position.

Since:

JViews 3.5

See Also:

getMaxVerticalPosition()

getVerticalPosition

int getVerticalPosition()

Returns the beginning of the vertical range displayed by the scrollable.

Since:

JViews 3.5

See Also:

setVerticalPosition(int)

setVerticalPosition

void setVerticalPosition(int position)

Sets the beginning of the vertical range displayed by the scrollable. The specified value is compared against the max displayable value and is trimmed if necessary. A verticalPositionChanged event is then fired to all registered listeners.

Parameters:

position - The new position.

Since:

JViews 3.5

See Also:

getVerticalPosition()

getVerticalExtent

int getVerticalExtent()

Returns the extent of the vertical range displayed by the scrollable.

Since:

JViews 3.5

See Also:

setVerticalExtent(int)

setVerticalExtent

void setVerticalExtent(int extent)

Sets the extent of the vertical range displayed by the scrollable. The specified value is compared against the max displayable value and is trimmed if necessary. A verticalExtentChanged event is then fired to all registered listeners.

Parameters:

extent - The new extent.

Since:

JViews 3.5

See Also:

getVerticalExtent()

addVerticalScrollListener

void addVerticalScrollListener(VerticalScrollListener listener)

Adds the specified listener to receive vertical scroll events from this scrollable.

Parameters:

listener - The listener that will be subscribed to subsequent scroll events.

Since:

JViews 3.5

See Also:

removeVerticalScrollListener(ilog.views.gantt.event.VerticalScrollListener)

removeVerticalScrollListener

void removeVerticalScrollListener(VerticalScrollListener listener)

Removes the specified listener so that it will no longer receive vertical scroll events from this scrollable.

Parameters:

listener - The listener that will be unsubscribed from receiving vertical scroll events.

Since:

JViews 3.5

See Also:

addVerticalScrollListener(ilog.views.gantt.event.VerticalScrollListener)