org.vaadin.extension.gridscroll

Class GridScrollExtension<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.server.AbstractExtension

org.vaadin.extension.gridscroll.GridScrollExtension<T>

Type Parameters:

T - Bean type of the Grid

All Implemented Interfaces:

com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Extension, com.vaadin.shared.Connector, Serializable

public class GridScrollExtension<T>
extends com.vaadin.server.AbstractExtension

GridScrollExtension is multi purpose Grid enhancement package. It features additional events (resize, scroll, etc.), methods for pixelwise scrolling and methods for componsating empty space appearing to Grid right side when columns or Grid is being resized.

Author:

Tatu Lund

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GridScrollExtension.GridColumnsResizedListener<T> A Listener interface for GridColumnsResizedEvent
static interface	GridScrollExtension.GridRenderedListener<T> A Listener interface for GridRenderedEvent
static interface	GridScrollExtension.GridResizedListener<T> A Listener interface for GridResizedEvent
static interface	GridScrollExtension.GridScrolledListener<T> A listener interface for GridScrolledEvent

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Constructor Summary

Constructors

Constructor and Description
GridScrollExtension(com.vaadin.ui.Grid<T> grid) Constructor method for the extension

Method Summary

Modifier and Type	Method and Description
com.vaadin.shared.Registration	addGridColumnsResizedListener(GridScrollExtension.GridColumnsResizedListener<T> listener) Add a new GridScrollExtension.GridColumnsResizedListener The GridColumnsResizedEvent event is fired every time Grid column sizes has been changed Note, there is similar event in Grid, but that is fired before you can fetch real column widths, this event is fired after widths are available, hence you can get correct widths
com.vaadin.shared.Registration	addGridRenderedListener(GridScrollExtension.GridRenderedListener<T> listener) Add a new GridRenderedListener The GridRenderedEvent event is fired once after Grid's initial column width calculation is complete
com.vaadin.shared.Registration	addGridResizedListener(GridScrollExtension.GridResizedListener<T> listener) Add a new GridScrollExtension.GridResizedListener The GridResizedEvent event is fired every time Grid size has been changed when setColumnResizeCompensationMode(org.vaadin.extension.gridscroll.shared.ColumnResizeCompensationMode) with ColumnResizeCompensationMode.RESIZE_GRID has been applied.
com.vaadin.shared.Registration	addGridScrolledListener(GridScrollExtension.GridScrolledListener<T> listener) Add a new GridScrollExtension.GridScrolledListener The GridScrolledEvent event is fired when Grid scroll position changes
void	adjustGridWidth() Recalculate the Grid's width and adjust it to according to actual column widths Programmatic change of column widths do not trigger column resize event, hence you need to call this if you want to refit Grid
void	adjustLastColumnWidth() Adjust last the width of the last column to occupy remaining space (if such exist) Programmatic change of column widths do not trigger column resize event, hence you need to call this if you want to refit Grid
ColumnResizeCompensationMode	getColumnResizeCompensationMode() Get the current compensation mode
ColumnResizeCompensationMode	getColumnResizeComponesationMode() Deprecated. since 2.3.4, please use getColumnResizeCompensationMode() instead.
double	getColumnWidth(com.vaadin.ui.Grid.Column<?,?> column) Get actual width of the column by column reference Note: There is small delay after Grid has been attached before real widths are available
double	getColumnWidth(int i) Get actual width of the column by index Note: There is small delay after Grid has been attached before real widths are available
double	getColumnWidth(String columnId) Get actual width of the column by columnId Note: There is small delay after Grid has been attached before real widths are available
int	getHeight() Get actual height
int	getLastXPosition() Get X scroll position of the Grid
int	getLastYPosition() Get Y scroll position of the Grid
GridScrollExtensionState	getState()
int	getWidth() Get actual width
void	restoreScrollPosition() Make Grid to scroll to the last known scroll position
void	setAutoResizeWidth(boolean autoResizeWidth) Deprecated. since 2.3.0, use setColumnResizeCompensationMode(ColumnResizeCompensationMode) instead.
void	setColumnResizeCompensationMode(ColumnResizeCompensationMode mode) Set how Grid should be adjusted when columns are being resized by user ColumnResizeCompensationMode.RESIZE_GRID will adjust Grid width and ColumnResizeCompensationMode.RESIZE_COLUMN the last column.
void	setColumnResizeComponesationMode(ColumnResizeCompensationMode mode) Deprecated. since 2.3.4, please use setColumnResizeCompensationMode(ColumnResizeCompensationMode) instead.
void	setRestorePosition(boolean restorePosition) By default extension restores the last known position in order to make Grid recover position during TabSheet.Tab changes.
void	setScrollPosition(int Xposition, int Yposition) Set new scroll position in pixels and scroll grid to that position

Methods inherited from class com.vaadin.server.AbstractExtension

extend, getParent, getSupportedParentType, remove, setParent

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, attach, beforeClientResponse, createState, detach, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getState, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isConnectorEnabled, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, attach, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, getUI, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Constructor Detail

GridScrollExtension

public GridScrollExtension(com.vaadin.ui.Grid<T> grid)

Constructor method for the extension

Parameters:

grid - Grid to be extended

Method Detail

addGridRenderedListener

public com.vaadin.shared.Registration addGridRenderedListener(GridScrollExtension.GridRenderedListener<T> listener)

Add a new GridRenderedListener The GridRenderedEvent event is fired once after Grid's initial column width calculation is complete

Parameters:

listener - A GridRenderedListener to be added

Since:

2.2.0

addGridResizedListener

public com.vaadin.shared.Registration addGridResizedListener(GridScrollExtension.GridResizedListener<T> listener)

Add a new GridScrollExtension.GridResizedListener The GridResizedEvent event is fired every time Grid size has been changed when setColumnResizeCompensationMode(org.vaadin.extension.gridscroll.shared.ColumnResizeCompensationMode) with ColumnResizeCompensationMode.RESIZE_GRID has been applied.

Parameters:

listener - A GridResizedListener to be added

Since:

2.2.0

addGridColumnsResizedListener

public com.vaadin.shared.Registration addGridColumnsResizedListener(GridScrollExtension.GridColumnsResizedListener<T> listener)

Add a new GridScrollExtension.GridColumnsResizedListener The GridColumnsResizedEvent event is fired every time Grid column sizes has been changed Note, there is similar event in Grid, but that is fired before you can fetch real column widths, this event is fired after widths are available, hence you can get correct widths

Parameters:

listener - A GridColumnsResizedListener to be added

Since:

2.2.0

addGridScrolledListener

public com.vaadin.shared.Registration addGridScrolledListener(GridScrollExtension.GridScrolledListener<T> listener)

Add a new GridScrollExtension.GridScrolledListener The GridScrolledEvent event is fired when Grid scroll position changes

Parameters:

listener - A GridScrolledListener to be added

Since:

2.2.0

adjustGridWidth

public void adjustGridWidth()

Recalculate the Grid's width and adjust it to according to actual column widths Programmatic change of column widths do not trigger column resize event, hence you need to call this if you want to refit Grid

Since:

2.2.0

adjustLastColumnWidth

public void adjustLastColumnWidth()

Adjust last the width of the last column to occupy remaining space (if such exist) Programmatic change of column widths do not trigger column resize event, hence you need to call this if you want to refit Grid

getColumnWidth

public double getColumnWidth(com.vaadin.ui.Grid.Column<?,?> column)

Get actual width of the column by column reference Note: There is small delay after Grid has been attached before real widths are available

Parameters:

column - The column reference

Returns:

Actual width of the column in pixels double value

Since:

2.1.0

getColumnWidth

public double getColumnWidth(String columnId)

Get actual width of the column by columnId Note: There is small delay after Grid has been attached before real widths are available

Parameters:

columnId - Id string / property name of the column

Returns:

Actual width of the column in pixels double value

Since:

2.1.0

getColumnWidth

public double getColumnWidth(int i)

Get actual width of the column by index Note: There is small delay after Grid has been attached before real widths are available

Parameters:

i - Index of the column

Returns:

Actual width of the column in pixels double value

Since:

2.1.0

restoreScrollPosition

public void restoreScrollPosition()

Make Grid to scroll to the last known scroll position

getLastXPosition

public int getLastXPosition()

Get X scroll position of the Grid

Returns:

Scroll position X coordinate in pixels as int

getLastYPosition

public int getLastYPosition()

Get Y scroll position of the Grid

Returns:

Scroll position Y coordinate in pixels as int

getWidth

public int getWidth()

Get actual width

Returns:

The last reported actual width of the Grid

Since:

2.2.0

getHeight

public int getHeight()

Get actual height

Returns:

The last reported actual height of the Grid

Since:

2.2.0

setScrollPosition

public void setScrollPosition(int Xposition,
                              int Yposition)

Set new scroll position in pixels and scroll grid to that position

Parameters:

Xposition - The new y scroll position

Yposition - The new y scroll position

setAutoResizeWidth

@Deprecated
public void setAutoResizeWidth(boolean autoResizeWidth)

Deprecated. since 2.3.0, use setColumnResizeCompensationMode(ColumnResizeCompensationMode) instead.

Set Grid to resize itself according to column widths automatically

Parameters:

autoResizeWidth - If true Grid resizes itself to column widths

setColumnResizeComponesationMode

@Deprecated
public void setColumnResizeComponesationMode(ColumnResizeCompensationMode mode)

Deprecated. since 2.3.4, please use setColumnResizeCompensationMode(ColumnResizeCompensationMode) instead.

setColumnResizeCompensationMode

public void setColumnResizeCompensationMode(ColumnResizeCompensationMode mode)

Set how Grid should be adjusted when columns are being resized by user ColumnResizeCompensationMode.RESIZE_GRID will adjust Grid width and ColumnResizeCompensationMode.RESIZE_COLUMN the last column. Default is ColumnResizeCompensationMode.NONE. Note: ColumnResizeCompensationMode.RESIZE_COLUM takes effect also when Grid is being resized. Note: When ColumnResizeCompensationMode.RESIZE_COLUM is used, the Grid.Column.setMaximumWidth(double) cannot be used with the last column

Parameters:

mode - ColumnResizeCompensationMode

Since:

2.3.0

getColumnResizeComponesationMode

@Deprecated
public ColumnResizeCompensationMode getColumnResizeComponesationMode()

Deprecated. since 2.3.4, please use getColumnResizeCompensationMode() instead.

getColumnResizeCompensationMode

public ColumnResizeCompensationMode getColumnResizeCompensationMode()

Get the current compensation mode

Returns:

The current compensation mode

Since:

2.3.0

getState

public GridScrollExtensionState getState()

Overrides:

getState in class com.vaadin.server.AbstractClientConnector

setRestorePosition

public void setRestorePosition(boolean restorePosition)

By default extension restores the last known position in order to make Grid recover position during TabSheet.Tab changes. There is a side effect of this, that Grid.scrollTo(int) does not work when calling right after Grid has been created. This feature can be turned off if needed by setting this to false.

Parameters:

restorePosition - Use false to disable automatic position restore feature

Since:

2.3.3