ilog.views.gantt.scale

Class IlvVisibleTimeScaleRows

java.lang.Object

ilog.views.gantt.scale.IlvVisibleTimeScaleRows

public class IlvVisibleTimeScaleRows
extends Object

The IlvVisibleTimeScaleRows class provides a way to specify a predicate associated to a list of rows.

A particular IlvVisibleTimeScaleRows instance is tied to a specific IlvTimeScale.

Since:

JViews 6.0

See Also:

IlvBasicTimeScaleVisibilityPolicy.addVisibleTimeScaleRows(ilog.views.gantt.scale.IlvVisibleTimeScaleRows)

Constructor Summary

Constructors

Constructor and Description
IlvVisibleTimeScaleRows() Creates a new IlvVisibleTimeScaleRows.
IlvVisibleTimeScaleRows(IlvVisibilityPredicate predicate) Creates a new IlvVisibleTimeScaleRows, with a predicate.

Method Summary

Modifier and Type	Method and Description
void	addRow(IlvTimeScaleRow row) Appends a row to the list of rows.
IlvVisibilityPredicate	getPredicate() Returns the predicate that determines the visibility of the time scale rows.
IlvTimeScaleRow[]	getRows() Returns an array of all rows.
int	getRowSize() Returns the number of rows contained in this visibility predicate.
boolean	getVisibilityStatus(Graphics dst, IlvTimeScale.PaintContext context) Gets the visibility status of this predicate.
void	insertRowAt(IlvTimeScaleRow row, int index) Inserts a row at the specified index in the list of rows.
protected void	invalidate() Marks this predicate as invalid, if it refers to rows of the time scale, because some time scale rows have changed.
void	setPredicate(IlvVisibilityPredicate predicate) Sets the predicate for controlling the visibility of the time scale rows.
void	setRow(int index, IlvTimeScaleRow row) Sets a row at the specified index in the list of rows.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvVisibleTimeScaleRows

public IlvVisibleTimeScaleRows()

Creates a new IlvVisibleTimeScaleRows.

IlvVisibleTimeScaleRows

public IlvVisibleTimeScaleRows(IlvVisibilityPredicate predicate)

Creates a new IlvVisibleTimeScaleRows, with a predicate.

Parameters:

predicate - The IlvVisibilityPredicate.

Method Detail

setPredicate

public void setPredicate(IlvVisibilityPredicate predicate)

Sets the predicate for controlling the visibility of the time scale rows. A null predicate implies a value of true and that the rows will always be visible.

Parameters:

predicate - The visibility predicate or null

getPredicate

public IlvVisibilityPredicate getPredicate()

Returns the predicate that determines the visibility of the time scale rows. A null value implies a predicate that is always true and indicates that the rows will always be visible. returned, this predicate is always true.

Returns:

The visibility predicate, or null.

getRowSize

public int getRowSize()

Returns the number of rows contained in this visibility predicate.

addRow

public void addRow(IlvTimeScaleRow row)

Appends a row to the list of rows.

Parameters:

row - The row to be appended.

insertRowAt

public void insertRowAt(IlvTimeScaleRow row,
                        int index)

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

Parameters:

row - The row to be inserted.

index - The index to insert the row at.

Throws:

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

setRow

public void setRow(int index,
                   IlvTimeScaleRow row)

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

Parameters:

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

row - The row to be set.

Throws:

IndexOutOfBoundsException - if index < 0.

getRows

public IlvTimeScaleRow[] getRows()

Returns an array of all rows.

Returns:

An array of IlvTimeScaleRow.

See Also:

setRow(int, ilog.views.gantt.scale.IlvTimeScaleRow), addRow(ilog.views.gantt.scale.IlvTimeScaleRow)

invalidate

protected void invalidate()

Marks this predicate as invalid, if it refers to rows of the time scale, because some time scale rows have changed.

Since:

JViews 8.8

getVisibilityStatus

public boolean getVisibilityStatus(Graphics dst,
                                   IlvTimeScale.PaintContext context)

Gets the visibility status of this predicate.

Parameters:

dst - The destination graphics.

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

Returns:

true if the predicate is satisfied, false otherwise.