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>

Type Parameters:

T - type of the form's main cursor

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

Base Java class for Lyra grid form.

Field Summary

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

PROPERTIES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getApproxTotalCount() Returns (approximate) total record count.
GridRefinementHandler	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(ru.curs.celesta.CallContext ctx) Returns contents of grid for current cursor's position.
List<LyraFormData>	getRows(ru.curs.celesta.CallContext ctx, int position) Returns contents of grid given scrollbar's position.
List<LyraFormData>	getRowsH(ru.curs.celesta.CallContext ctx, int h) Returns contents of grid for current cursor's position.
List<LyraFormData>	getRowsH(ru.curs.celesta.CallContext ctx, 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(ru.curs.celesta.CallContext ctx)
void	saveCursorPosition(ru.curs.celesta.CallContext ctx)
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(ru.curs.celesta.CallContext ctx, Object... pk)
List<LyraFormData>	setPositionH(ru.curs.celesta.CallContext ctx, 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, rec

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,
                     GridRefinementHandler changeNotifier)

Method Detail

getRows

public List<LyraFormData> getRows(ru.curs.celesta.CallContext ctx,
                                  int position)

Returns contents of grid given scrollbar's position.

Parameters:

ctx - current CallContext

position - New scrollbar's position.

getRowsH

public List<LyraFormData> getRowsH(ru.curs.celesta.CallContext ctx,
                                   int position,
                                   int h)

Returns contents of grid given scrollbar's position.

Parameters:

ctx - current CallContext

position - New scrollbar's position.

h - Form's height in rows

getRows

public List<LyraFormData> getRows(ru.curs.celesta.CallContext ctx)

Returns contents of grid for current cursor's position.

Parameters:

ctx - current CallContext

getRowsH

public List<LyraFormData> getRowsH(ru.curs.celesta.CallContext ctx,
                                   int h)

Returns contents of grid for current cursor's position.

Parameters:

ctx - current CallContext

h - form height in rows

setPosition

public List<LyraFormData> setPosition(ru.curs.celesta.CallContext ctx,
                                      Object... pk)

setPositionH

public List<LyraFormData> setPositionH(ru.curs.celesta.CallContext ctx,
                                       int h,
                                       Object... pk)

Positions grid to a certain record.

Parameters:

ctx - current CallContext

pk - Values of primary key

getChangeNotifier

public GridRefinementHandler 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(ru.curs.celesta.CallContext ctx)

restoreCursorPosition

public void restoreCursorPosition(ru.curs.celesta.CallContext ctx)

getGridHeight

public int getGridHeight()

Should return a number of rows in grid.

getSummaryRow

public Map<String,String> getSummaryRow()

Should return a summary row.