ilog.views.gantt.scale

Class IlvBasicTimeScaleVisibilityPolicy

java.lang.Object

ilog.views.gantt.scale.IlvBasicTimeScaleVisibilityPolicy

All Implemented Interfaces:

IlvTimeScaleVisibilityPolicy

Direct Known Subclasses:

IlvGanttTimeScaleVisibilityPolicy

public class IlvBasicTimeScaleVisibilityPolicy
extends Object
implements IlvTimeScaleVisibilityPolicy

Implements a default visibility policy for the IlvTimeScale. This policy determines which rows are visible when the time scale is resized, based on visibility predicates applied to the paint context object.

This policy keeps track of each visibility predicate in a specified order, with its set of visible rows. When asked to adjust the visibility of the rows, the first visibility predicate that evaluates to true is the one used for adjusting the rows.

A particular IlvBasicTimeScaleVisibilityPolicy instance is tied to a specific IlvTimeScale.

Since:

JViews 6.0

See Also:

IlvTimeScale.setVisibilityPolicy(ilog.views.gantt.scale.IlvTimeScaleVisibilityPolicy), IlvVisibleTimeScaleRows

Constructor Summary

Constructors

Constructor and Description
IlvBasicTimeScaleVisibilityPolicy() Initializes a new IlvBasicTimeScaleVisibilityPolicy.

Method Summary

Modifier and Type	Method and Description
void	addVisibleTimeScaleRows(IlvVisibleTimeScaleRows visibleTsRows) Appends a IlvVisibleTimeScaleRows object to the list of visible time scale rows.
void	adjustRows(Graphics dst, IlvTimeScale.PaintContext context) Adjusts the visible time scale rows for the specified time scale.
IlvVisibleTimeScaleRows	getVisibleTimeScaleRows(int index) Returns the visibility predicate and its associated visible rows defined at the specified index in this visibility policy.
int	getVisibleTimeScaleRowsSize() Returns the number of defined visible time scale rows contained in the visibility policy.
void	insertVisibleTimeScaleRowsAt(IlvVisibleTimeScaleRows visibleTsRows, int index) Inserts a IlvVisibleTimeScaleRows at the specified index in the list of visible time scale rows.
void	rowsChanged(IlvTimeScale timeScale) This method is called when some rows of the time scale have changed.
void	setVisibleTimeScaleRows(int index, IlvVisibleTimeScaleRows visibleTsRows) Sets an IlvVisibleTimeScaleRows at the specified index in the list of IlvVisibleTimeScaleRows.
protected void	updateRows(IlvTimeScale timeScale, int index) Updates the rows in the time scale.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvBasicTimeScaleVisibilityPolicy

public IlvBasicTimeScaleVisibilityPolicy()

Initializes a new IlvBasicTimeScaleVisibilityPolicy.

Method Detail

getVisibleTimeScaleRowsSize

public int getVisibleTimeScaleRowsSize()

Returns the number of defined visible time scale rows contained in the visibility policy.

getVisibleTimeScaleRows

public IlvVisibleTimeScaleRows getVisibleTimeScaleRows(int index)

Returns the visibility predicate and its associated visible rows defined at the specified index in this visibility policy. If there is no defined visible time scale rows at the specified index, then null is returned.

Parameters:

index - The index of the visible time scale rows.

Throws:

IndexOutOfBoundsException - if index < 0.

addVisibleTimeScaleRows

public void addVisibleTimeScaleRows(IlvVisibleTimeScaleRows visibleTsRows)

Appends a IlvVisibleTimeScaleRows object to the list of visible time scale rows.

Parameters:

visibleTsRows - The visibility predicate and its associated visible rows to be appended.

insertVisibleTimeScaleRowsAt

public void insertVisibleTimeScaleRowsAt(IlvVisibleTimeScaleRows visibleTsRows,
                                         int index)

Inserts a IlvVisibleTimeScaleRows at the specified index in the list of visible time scale rows. The IlvVisibleTimeScaleRows at that position and all subsequent IlvVisibleTimeScaleRows are shifted to the right, having their indices incremented.

Parameters:

visibleTsRows - The visible time scale rows to be inserted.

index - The index to insert the visible rows at.

Throws:

IndexOutOfBoundsException - if index < 0 || index > getVisibleTimeScaleRowsSize().

setVisibleTimeScaleRows

public void setVisibleTimeScaleRows(int index,
                                    IlvVisibleTimeScaleRows visibleTsRows)

Sets an IlvVisibleTimeScaleRows at the specified index in the list of IlvVisibleTimeScaleRows. The old visible time scale rows at this position will be removed. If the position is greater than the last visible time scale rows position, null visible time scale rows are added in-between.

Parameters:

index - The index at which the IlvVisibleTimeScaleRows should be set.

visibleTsRows - The visible time scale rows to be set.

Throws:

IndexOutOfBoundsException - if index < 0.

adjustRows

public void adjustRows(Graphics dst,
                       IlvTimeScale.PaintContext context)

Adjusts the visible time scale rows for the specified time scale. This basic implementation looks for the first predicate which evaluates to true and gets the time scale rows associated to this predicate. The time scale rows update is done in the updateRows(ilog.views.gantt.scale.IlvTimeScale, int) method.

Specified by:

adjustRows in interface IlvTimeScaleVisibilityPolicy

Parameters:

dst - The destination graphics, can be null.

context - The IlvTimeScale.PaintContextcontext in which the time scale paints.

updateRows

protected void updateRows(IlvTimeScale timeScale,
                          int index)

Updates the rows in the time scale. This default implementation gets the rows from the IlvVisibleTimeScaleRows, and changes the time scale rows.

Parameters:

timeScale - The time scale.

index - The index in the visible time scale rows where to get the visible rows from.

rowsChanged

public void rowsChanged(IlvTimeScale timeScale)

This method is called when some rows of the time scale have changed. The default implementation marks all rows invalid.

Since:

JViews 8.8