com.modeliosoft.modelio.api.modelio.matrix.model

Interface IMatrixContentAccessor

All Known Implementing Classes:

AbstractMatrixContentAccessor

public interface IMatrixContentAccessor

Matrix content accessor.

Method Summary

Modifier and Type	Method and Description
MatrixValueDefinition	getDefinition()
java.util.List<java.lang.String>	getPossibleValues(java.lang.Object col, java.lang.Object row, java.lang.Object depth) Get the possible values for a selected cell.
java.lang.Class<?>	getType(java.lang.Object col, java.lang.Object row, java.lang.Object depth) Get the type of a selected cell.
java.lang.Object	getVal(java.lang.Object col, java.lang.Object row, java.lang.Object depth) Get the value of a selected cell.
boolean	isEditable(java.lang.Object col, java.lang.Object row, java.lang.Object depth) Indicate whether or not a selected cell can be edited.
default boolean	isLineColumnSwitchSupported() Tells whether this accessor still works if line and column are switched.
void	setVal(java.lang.Object col, java.lang.Object row, java.lang.Object depth, java.lang.Object value) Set the value of a selected cell.
void	updateStyle(java.lang.Object col, java.lang.Object row, java.lang.Object depth, IMatrixStyle style) Update the style parameters of a selected cell.

Method Detail

getPossibleValues

java.util.List<java.lang.String> getPossibleValues(java.lang.Object col,
                                                   java.lang.Object row,
                                                   java.lang.Object depth)

Get the possible values for a selected cell.

Parameters:

col - the object on the col line.

row - the object on the row line. Might be null.

depth - the object on the depth line. Might be null.

Returns:

the values applicable for this cell, in String form. A null value means all values are possible.

getType

java.lang.Class<?> getType(java.lang.Object col,
                           java.lang.Object row,
                           java.lang.Object depth)

Get the type of a selected cell.

Parameters:

col - the object on the col line.

row - the object on the row line. Might be null.

depth - the object on the depth line. Might be null.

Returns:

a class type. Must not be null.

isEditable

boolean isEditable(java.lang.Object col,
                   java.lang.Object row,
                   java.lang.Object depth)

Indicate whether or not a selected cell can be edited.

Parameters:

col - the object on the col line.

row - the object on the row line. Might be null.

depth - the object on the depth line. Might be null.

Returns:

true if the cell can be edited, false otherwise.

getVal

java.lang.Object getVal(java.lang.Object col,
                        java.lang.Object row,
                        java.lang.Object depth)

Get the value of a selected cell.

Parameters:

col - the object on the col line.

row - the object on the row line. Might be null.

depth - the object on the depth line. Might be null.

Returns:

an object. Might be null.

setVal

void setVal(java.lang.Object col,
            java.lang.Object row,
            java.lang.Object depth,
            java.lang.Object value)

Set the value of a selected cell.

Parameters:

col - the object on the col line.

row - the object on the row line. Might be null.

depth - the object on the depth line. Might be null.

value - the new value. Might be null.

updateStyle

void updateStyle(java.lang.Object col,
                 java.lang.Object row,
                 java.lang.Object depth,
                 IMatrixStyle style)

Update the style parameters of a selected cell.

Parameters:

col - the object on the col line.

row - the object on the row line. Might be null.

depth - the object on the depth line. Might be null.

style - the style to edit.

getDefinition

MatrixValueDefinition getDefinition()

Returns:

the value definition

isLineColumnSwitchSupported

default boolean isLineColumnSwitchSupported()

Tells whether this accessor still works if line and column are switched.

If true, the other methods will be called with line and column arguments switched. If false, they will be called as if line and column are not switched.

The default implementation returns false.

Returns:

whether this accessor supports line and column being switched.

Since:

3.8