com.technia.tvc.gridbrowser.model

Interface GridBrowserModel

All Superinterfaces:

AttributeSupport

public interface GridBrowserModel
extends AttributeSupport

Since:

5.0

Method Summary

Modifier and Type	Method and Description
com.technia.tvc.gridbrowser.def.GridBrowserDef	getDef() Returns the definition that controls the behavior of this instance.
com.technia.tvc.gridbrowser.model.GridDimension	getDimension() Returns the dimension for this grid.
Element	getElementFor(TableData row, TableData col)
com.technia.tvc.gridbrowser.model.GridPosition	getElementPosition(Element element) Returns the position of an element within the grid.
java.util.Iterator<Element>	getElements() Returns the elements, from left->right, top->bottom.
java.util.Iterator<Element>	getElementsAtSameIntersection(Element e) Returns the elements, which shares the same intersection point.
java.util.Iterator<Element>	getElementsWithSameConnectionId(Element e) Returns all the elements, which has the same connection id as the specified element
Element	getElementWithId(long id) Returns the element that has the specified id.
GridAxes	getGridAxes() Returns the GridAxes instance, which holds the data on the row and col axis.
com.technia.tvc.gridbrowser.model.Intersection	getIntersection(Element e)
void	invalidate() This method can be used to invalidate the grid and force a revalidation by calling validate(Environment).
boolean	isValid() This method returns true if the grid is valid.
void	validate(Environment env) This method should be called to validate the grid when the isValid() returns false.

Methods inherited from interface com.technia.tvc.core.util.AttributeSupport

getAttribute, getAttributeNames, removeAttribute, setAttribute

Method Detail

getDimension

com.technia.tvc.gridbrowser.model.GridDimension getDimension()

Returns the dimension for this grid.

getDef

com.technia.tvc.gridbrowser.def.GridBrowserDef getDef()

Returns the definition that controls the behavior of this instance.

getElementsAtSameIntersection

java.util.Iterator<Element> getElementsAtSameIntersection(Element e)

Returns the elements, which shares the same intersection point. E.g. the row object, and column object are identical.

Parameters:

e - The element

Returns:

An iterator.

getElementsWithSameConnectionId

java.util.Iterator<Element> getElementsWithSameConnectionId(Element e)

Returns all the elements, which has the same connection id as the specified element

Parameters:

e - The element

Returns:

An iterator.

getElementWithId

Element getElementWithId(long id)

Returns the element that has the specified id. If such element does not exist within this model, null is returned.

getIntersection

com.technia.tvc.gridbrowser.model.Intersection getIntersection(Element e)

getElementFor

Element getElementFor(TableData row,
                      TableData col)

getElements

java.util.Iterator<Element> getElements()

Returns the elements, from left->right, top->bottom.

validate

void validate(Environment env)
       throws TVCException

This method should be called to validate the grid when the isValid() returns false. Exactly what is validated is up to the implementing classes to decide.

Throws:

TVCException

isValid

boolean isValid()
         throws TVCException

This method returns true if the grid is valid. An invalid grid has to be validated before displayed.

Throws:

TVCException

invalidate

void invalidate()

This method can be used to invalidate the grid and force a revalidation by calling validate(Environment).

getGridAxes

GridAxes getGridAxes()

Returns the GridAxes instance, which holds the data on the row and col axis.

getElementPosition

com.technia.tvc.gridbrowser.model.GridPosition getElementPosition(Element element)

Returns the position of an element within the grid.

Parameters:

element - The element

Returns:

The position