com.cc.framework.ui.control
Interface LineIterator

All Known Implementing Classes:

ListLineIterator, TreeLineIterator, VirtualKeyListLineIterator, VirtualListLineIterator

public interface LineIterator

Interface for line iterators

Since:

1.0

Version:

$Revision: 1.15 $

Author:

Harald Schulz

Method Summary

java.lang.Object	current() Returns the Object at the current position
java.lang.Object	current(java.lang.String property) Method current
int	currentCheckState() Returns the Check state -1 = The Item can not be checked.
int	currentIndex() Returns the current row index (offset between the first line and the current line)
java.lang.String	currentKey() Method curentKey
boolean	done() Checks if all items are processed
boolean	isMarked() Checks if the current Item is highlighted
boolean	isValidProperty(java.lang.String property) Checks if the current iteration element has the given property
void	next() Moves to the next element
void	prev() Moves to the previous element
void	reset() resets the iterator to the first element of the collection

Method Detail

done

public boolean done()

Checks if all items are processed

Returns:

boolean

current

public java.lang.Object current()

Returns the Object at the current position

Returns:

Object

current

public java.lang.Object current(java.lang.String property)

Method current

Parameters:

property - Bean Property Name

Returns:

Property Value

currentKey

public java.lang.String currentKey()

Method curentKey

Returns:

String

currentIndex

public int currentIndex()

Returns the current row index (offset between the first line and the current line)

Returns:

row index

isValidProperty

public boolean isValidProperty(java.lang.String property)

Checks if the current iteration element has the given property

Parameters:

property - the property name

Returns:

true if the current bean possesses a matching property

isMarked

public boolean isMarked()

Checks if the current Item is highlighted

Returns:

boolean True if the current item is selected

currentCheckState

public int currentCheckState()

Returns the Check state

• -1 = The Item can not be checked. It has no Property
• 0 = The Item is not checked
• 1 = The Item is checked
• 2 = the state is undefined

Returns:

integer

next

public void next()

Moves to the next element

prev

public void prev()

Moves to the previous element

reset

public void reset()

resets the iterator to the first element of the collection