Package com.levigo.jadice.web.client.grid

Class Grids

java.lang.Object

com.levigo.jadice.web.client.grid.Grids

public class Grids
extends Object

Utility methods to attach a Grid to a Document and retrieve or remove it.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_KEY_GRID_INSTANCE	A Grid is stored in the document properties under this property key.

Method Summary

Modifier and Type	Method	Description
static void	attachGridToDocument(Document doc, Grid grid)	Attaches the given Grid to the document by putting it into the document properties.
static Grid	getGridForDocument(Document doc)	Returns the Grid for the given document.
static boolean	hasGrid(Document doc)	Checks if the given document has a Grid set in its document properties.
static void	removeGridFromDocument(Document doc)	Removes the known grid properties from the given map.

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY_KEY_GRID_INSTANCE

public static final String PROPERTY_KEY_GRID_INSTANCE

A Grid is stored in the document properties under this property key. As a Grid lives only temporarily on the Client side, this property will never be transferred to the server or persisted.

See Also:

• Constant Field Values

Method Details

hasGrid

public static boolean hasGrid(Document doc)

Checks if the given document has a Grid set in its document properties.

Parameters:

doc - the document

Returns:

true: The document has a grid set in the properties; false otherwise

getGridForDocument

public static Grid getGridForDocument(Document doc)

Returns the Grid for the given document. The grid will be fetched from the document properties.

If there is no grid specified in the document properties, a new NoOpGrid will be returned.

Parameters:

doc - the document

Returns:

the grid (never null)

attachGridToDocument

public static void attachGridToDocument(Document doc,
 Grid grid)

Attaches the given Grid to the document by putting it into the document properties.

Parameters:

doc - the document

grid - the grid

removeGridFromDocument

public static void removeGridFromDocument(Document doc)

Removes the known grid properties from the given map.

Parameters:

doc - the properties to remove the grid settings from