net.sourceforge.openutils.mgnlcontrols.configuration

Interface GridColumnType

All Known Implementing Classes:

AbstractGridColumnType, CheckboxGridColumnType, ColorGridColumnType, ComboGridColumnType, DateGridColumnType, EditCodeGridColumnType, FckEditorGridColumnType, FileGridColumnType, LinkGridColumnType, TextGridColumnType, UUIDLinkGridColumnType

public interface GridColumnType

Defines a column of the grid control. Methods are called by the grid control, the freemarker template and the save handler.

Version:

$Id: GridColumnType.java 3752 2012-03-10 09:00:25Z fgiust $

Author:

dschivo

Method Summary

Methods

Modifier and Type	Method and Description
String	drawColumnJs(String propertyName, int colIndex, Map colmap, info.magnolia.cms.i18n.Messages msgs) Gets the javascript object for the column model of the grid.
String	drawSupportHtml(String propertyName, int colIndex, Map colmap, info.magnolia.cms.i18n.Messages msgs) Adds extra markup to be used by the column, if needed.
String	getHeadSnippet() Gets the html code for Including scripts and styles for the column.
void	processColumnOnLoad(String[] column, info.magnolia.cms.core.Content colConfig) Possibly transforms the column values on grid load.
void	processColumnOnSave(String[] column, info.magnolia.cms.core.Content colConfig, String propertyName, info.magnolia.cms.core.Content parentNode) Possibly transforms the column values on grid save.

Method Detail

getHeadSnippet

String getHeadSnippet()

Gets the html code for Including scripts and styles for the column. Called only once for each column type.

Returns:

drawSupportHtml

String drawSupportHtml(String propertyName,
                     int colIndex,
                     Map colmap,
                     info.magnolia.cms.i18n.Messages msgs)

Adds extra markup to be used by the column, if needed.

Parameters:

propertyName -

colIndex -

colmap -

msgs -

Returns:

drawColumnJs

String drawColumnJs(String propertyName,
                  int colIndex,
                  Map colmap,
                  info.magnolia.cms.i18n.Messages msgs)

Gets the javascript object for the column model of the grid.

Parameters:

propertyName -

colIndex -

colmap -

msgs -

Returns:

processColumnOnLoad

void processColumnOnLoad(String[] column,
                       info.magnolia.cms.core.Content colConfig)

Possibly transforms the column values on grid load.

Parameters:

column -

colConfig -

processColumnOnSave

void processColumnOnSave(String[] column,
                       info.magnolia.cms.core.Content colConfig,
                       String propertyName,
                       info.magnolia.cms.core.Content parentNode)
                         throws javax.jcr.RepositoryException,
                                info.magnolia.cms.security.AccessDeniedException

Possibly transforms the column values on grid save.

Parameters:

column -

colConfig -

propertyName -

parentNode -

Throws:

javax.jcr.RepositoryException

info.magnolia.cms.security.AccessDeniedException