ru.curs.lyra.kernel

Class BasicGridForm<T extends ru.curs.celesta.dbutils.BasicCursor>

java.lang.Object

ru.curs.lyra.kernel.BasicLyraForm<T>

ru.curs.lyra.kernel.BasicGridForm<T>

public abstract class BasicGridForm<T extends ru.curs.celesta.dbutils.BasicCursor>
extends BasicLyraForm<T>

Base Java class for Lyra grid form.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BasicGridForm.ExternalAction<T>

Field Summary

Fields inherited from class ru.curs.lyra.kernel.BasicLyraForm

PROPERTIES

Constructor Summary

Constructors

Constructor and Description
BasicGridForm(ru.curs.celesta.CallContext context)

Method Summary

Modifier and Type	Method and Description
<T> T	externalAction(BasicGridForm.ExternalAction<T> f, T fallBack)
int	getApproxTotalCount() Returns (approximate) total record count.
Runnable	getChangeNotifier() Returns change notifier.
int	getGridHeight() Should return a number of rows in grid.
int	getMaxExactScrollValue() If the grid is scrolled less than for given amount of records, the exact positioning in cycle will be used instead of interpolation.
List<LyraFormData>	getRows()
List<LyraFormData>	getRows(int position)
List<LyraFormData>	getRowsH(int h) Returns contents of grid for current cursor's position.
List<LyraFormData>	getRowsH(int position, int h) Returns contents of grid given scrollbar's position.
Map<String,String>	getSummaryRow() Should return a summary row.
int	getTopVisiblePosition() Returns scrollbar's knob position for current cursor value.
void	restoreCursorPosition()
void	saveCursorPosition()
void	setChangeNotifier(Runnable callback) Sets change notifier to be run when refined grid parameters are ready.
void	setMaxExactScrollValue(int val) If the grid is scrolled less than for given amount of records, the exact positioning in cycle will be used instead of interpolation.
List<LyraFormData>	setPosition(Object... pk)
List<LyraFormData>	setPositionH(int h, Object... pk) Positions grid to a certain record.

Methods inherited from class ru.curs.lyra.kernel.BasicLyraForm

beforeSending, createAllBoundFields, createAllUnboundFields, createField, descOrders, getCursor, getFieldsMeta, getFormProperties, getId, meta, orderByColumnNames, setCallContext

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicGridForm

public BasicGridForm(ru.curs.celesta.CallContext context)

Method Detail

externalAction

public <T> T externalAction(BasicGridForm.ExternalAction<T> f,
                            T fallBack)

getRows

public List<LyraFormData> getRows(int position)

getRowsH

public List<LyraFormData> getRowsH(int position,
                                   int h)

Returns contents of grid given scrollbar's position.

Parameters:

position - New scrollbar's position.

getRows

public List<LyraFormData> getRows()

getRowsH

public List<LyraFormData> getRowsH(int h)

Returns contents of grid for current cursor's position.

setPosition

public List<LyraFormData> setPosition(Object... pk)

setPositionH

public List<LyraFormData> setPositionH(int h,
                                       Object... pk)

Positions grid to a certain record.

Parameters:

pk - Values of primary key.

setChangeNotifier

public void setChangeNotifier(Runnable callback)

Sets change notifier to be run when refined grid parameters are ready.

Parameters:

callback - A callback to be run.

getChangeNotifier

public Runnable getChangeNotifier()

Returns change notifier.

setMaxExactScrollValue

public void setMaxExactScrollValue(int val)

If the grid is scrolled less than for given amount of records, the exact positioning in cycle will be used instead of interpolation.

Parameters:

val - new value.

getMaxExactScrollValue

public int getMaxExactScrollValue()

If the grid is scrolled less than for given amount of records, the exact positioning in cycle will be used instead of interpolation.

getApproxTotalCount

public int getApproxTotalCount()

Returns (approximate) total record count.

Just after creation of the form this method returns DEFAULT_COUNT value, but it asynchronously requests total count right after constructor execution.

getTopVisiblePosition

public int getTopVisiblePosition()

Returns scrollbar's knob position for current cursor value.

saveCursorPosition

public void saveCursorPosition()

restoreCursorPosition

public void restoreCursorPosition()

getGridHeight

public int getGridHeight()

Should return a number of rows in grid.

getSummaryRow

public Map<String,String> getSummaryRow()

Should return a summary row.