ilog.views.gantt.swing

Class IlvVerticalBoundedRangeModel

java.lang.Object

ilog.views.util.swing.IlvAbstractBoundedRangeModel

ilog.views.gantt.swing.IlvVerticalBoundedRangeModel

All Implemented Interfaces:

IlvVerticalScrollable, Serializable, BoundedRangeModel

public class IlvVerticalBoundedRangeModel
extends IlvAbstractBoundedRangeModel
implements IlvVerticalScrollable

The IlvVerticalBoundedRangeModel class implements a model for bounded-range components, such as a JScrollBar or a JSlider. It also implements the IlvVerticalScrollable interface.

Since:

JViews 3.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvVerticalBoundedRangeModel() Creates a new IlvVerticalBoundedRangeModel with the following default values: value= 0 extent= 0 maximum= 100 adjusting= false

Method Summary

Modifier and Type	Method and Description
void	addVerticalScrollListener(VerticalScrollListener listener) Adds the specified listener to receive vertical scroll events from this model. scroll events.
protected void	fireMaxVerticalPositionChanged() Call this method to fire a maxVerticalPositionChanged event to all registered listeners.
protected void	fireVerticalExtentChanged() Call this method to fire a verticalExtentChanged event to all registered listeners.
protected void	fireVerticalPositionChanged() Call this method to fire a verticalPositionChanged event to all registered listeners.
int	getExtent() Returns the model's current extent.
int	getMaximum() Returns the model's maximum.
int	getMaxVerticalPosition() Returns the model's maximum position.
int	getMinimum() Returns the model's minimum acceptable value.
int	getValue() Returns the model's current value.
boolean	getValueIsAdjusting() Returns true if the current changes to the value property are part of a series of changes.
int	getVerticalExtent() Returns the extent of the model's vertical range.
int	getVerticalPosition() Returns the beginning of the model's vertical range.
void	removeVerticalScrollListener(VerticalScrollListener listener) Removes the specified listener so that it will no longer receive vertical scroll events from this model.
void	setExtent(int extent) Sets the model's extent.
void	setMaximum(int max) Sets the model's maximum.
void	setMaxVerticalPosition(int max) Sets the model's maximum position.
void	setMinimum(int min) Sets the model's minimum.
void	setRangeProperties(int value, int extent, int min, int max, boolean adjusting) This method sets all the model data with a single method call.
void	setValue(int value) Sets the model's value.
void	setValueIsAdjusting(boolean b) This attribute indicates that any upcoming changes to the value of the model should be considered a single event.
void	setVerticalExtent(int extent) Sets the extent of the model's vertical range.
void	setVerticalPosition(int position) Sets the beginning of the model's vertical range.

Methods inherited from class ilog.views.util.swing.IlvAbstractBoundedRangeModel

addChangeListener, fireStateChanged, removeChangeListener, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IlvVerticalBoundedRangeModel

public IlvVerticalBoundedRangeModel()

Creates a new IlvVerticalBoundedRangeModel with the following default values:

• value= 0
• extent= 0
• maximum= 100
• adjusting= false

Method Detail

getMinimum

public int getMinimum()

Returns the model's minimum acceptable value. An IlvVerticalScrollable always has a minimum value of 0.

Specified by:

getMinimum in interface BoundedRangeModel

Returns:

The model's minimum.

See Also:

setMinimum(int)

setMinimum

public void setMinimum(int min)

Sets the model's minimum. Because an IlvVerticalScrollable always has a minimum of 0, this method does nothing.

Specified by:

setMinimum in interface BoundedRangeModel

Parameters:

min - The minimum.

See Also:

getMinimum()

getMaximum

public int getMaximum()

Returns the model's maximum.

Specified by:

getMaximum in interface BoundedRangeModel

Returns:

The model's maximum.

See Also:

getMaxVerticalPosition(), setMaximum(int), setExtent(int)

setMaximum

public void setMaximum(int max)

Sets the model's maximum. The current value and extent are trimmed to fit the new 0-max range. If max < 0 an IllegalArgumentException will be thrown.

Specified by:

setMaximum in interface BoundedRangeModel

Parameters:

max - The maximum.

See Also:

setMaxVerticalPosition(int), getMaximum()

getValue

public int getValue()

Returns the model's current value.

Specified by:

getValue in interface BoundedRangeModel

Returns:

The model's value.

See Also:

getVerticalPosition(), setValue(int)

setValue

public void setValue(int value)

Sets the model's value. The specified value is compared against the max value and is trimmed if necessary.

Specified by:

setValue in interface BoundedRangeModel

Parameters:

value - The value.

See Also:

setVerticalPosition(int), getValue()

getExtent

public int getExtent()

Returns the model's current extent.

Specified by:

getExtent in interface BoundedRangeModel

Returns:

The model's extent.

See Also:

getVerticalExtent(), setExtent(int)

setExtent

public void setExtent(int extent)

Sets the model's extent. The specified value is compared against the max value and is trimmed if necessary.

Specified by:

setExtent in interface BoundedRangeModel

Parameters:

extent - The extent.

See Also:

setVerticalExtent(int), getExtent()

getValueIsAdjusting

public boolean getValueIsAdjusting()

Returns true if the current changes to the value property are part of a series of changes.

Specified by:

getValueIsAdjusting in interface BoundedRangeModel

Returns:

The valueIsAdjusting property.

See Also:

setValueIsAdjusting(boolean)

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)

This attribute indicates that any upcoming changes to the value of the model should be considered a single event. This attribute will be set to true at the start of a series of changes to the value, and will be set to false when the value has finished changing. Normally this allows a listener to only take action when the final value change is committed, instead of having to do updates for all intermediate values.

Sliders and scroll bars use this property when a drag is underway.

Specified by:

setValueIsAdjusting in interface BoundedRangeModel

Parameters:

b - true if the upcoming changes to the value property are part of a series.

See Also:

getValueIsAdjusting()

setRangeProperties

public void setRangeProperties(int value,
                               int extent,
                               int min,
                               int max,
                               boolean adjusting)

This method sets all the model data with a single method call. The method results in a single change event being generated. This is convenient when you need to adjust all the model data simultaneously and do not want individual change events to occur.

Specified by:

setRangeProperties in interface BoundedRangeModel

Parameters:

value - An int giving the current value.

extent - An int giving the amount by which the value can "jump".

min - An int giving the minimum value.

max - An int giving the maximum value.

adjusting - A boolean, true if a series of changes are in progress.

See Also:

setValue(int), setExtent(int), setMinimum(int), setMaximum(int), setValueIsAdjusting(boolean)

getMaxVerticalPosition

public int getMaxVerticalPosition()

Returns the model's maximum position.

Specified by:

getMaxVerticalPosition in interface IlvVerticalScrollable

Returns:

The maximum position.

See Also:

getMaximum(), setMaxVerticalPosition(int)

setMaxVerticalPosition

public void setMaxVerticalPosition(int max)

Sets the model's maximum position. 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.

Specified by:

setMaxVerticalPosition in interface IlvVerticalScrollable

Parameters:

max - The maximum position.

See Also:

setMaximum(int), getMaxVerticalPosition()

getVerticalPosition

public int getVerticalPosition()

Returns the beginning of the model's vertical range.

Specified by:

getVerticalPosition in interface IlvVerticalScrollable

See Also:

getValue(), setVerticalPosition(int)

setVerticalPosition

public void setVerticalPosition(int position)

Sets the beginning of the model's vertical range. The specified value is compared against the max value and is trimmed if necessary. A verticalPositionChanged event is then fired to all registered listeners.

Specified by:

setVerticalPosition in interface IlvVerticalScrollable

Parameters:

position - The new position.

See Also:

setValue(int), getVerticalPosition()

getVerticalExtent

public int getVerticalExtent()

Returns the extent of the model's vertical range.

Specified by:

getVerticalExtent in interface IlvVerticalScrollable

See Also:

getExtent(), setVerticalExtent(int)

setVerticalExtent

public void setVerticalExtent(int extent)

Sets the extent of the model's vertical range. The specified value is compared against the max value and is trimmed if necessary. A verticalExtentChanged event is then fired to all registered listeners.

Specified by:

setVerticalExtent in interface IlvVerticalScrollable

Parameters:

extent - The new extent.

See Also:

setExtent(int), getVerticalExtent()

addVerticalScrollListener

public void addVerticalScrollListener(VerticalScrollListener listener)

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

Specified by:

addVerticalScrollListener in interface IlvVerticalScrollable

Parameters:

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

See Also:

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

removeVerticalScrollListener

public void removeVerticalScrollListener(VerticalScrollListener listener)

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

Specified by:

removeVerticalScrollListener in interface IlvVerticalScrollable

Parameters:

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

See Also:

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

fireMaxVerticalPositionChanged

protected void fireMaxVerticalPositionChanged()

Call this method to fire a maxVerticalPositionChanged event to all registered listeners.

See Also:

setMaxVerticalPosition(int)

fireVerticalPositionChanged

protected void fireVerticalPositionChanged()

Call this method to fire a verticalPositionChanged event to all registered listeners.

See Also:

setVerticalPosition(int)

fireVerticalExtentChanged

protected void fireVerticalExtentChanged()

Call this method to fire a verticalExtentChanged event to all registered listeners.

See Also:

setVerticalExtent(int)