com.chap.links.client

Class DataConnector.Options

java.lang.Object

AbstractDrawOptions

com.chap.links.client.DataConnector.Options

Enclosing class:

DataConnector

public static class DataConnector.Options
extends AbstractDrawOptions

Options for drawing the treegrid. Create an instance via the method create, for example TreeGrid.Options options = TreeGrid.Options.create();

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataConnector.Options() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static DataConnector.Options	create() Create a Javascript object instance of Options()
void	setColumn(int index, java.lang.String name, java.lang.String text, java.lang.String title) Set name, text, and tile for a column.
void	setColumnFormat(int index, JavaScriptObject format) Set a format function for a column to format the output.
void	setColumnFormat(int index, java.lang.String format) Set a format function for a column to format the output.
void	setColumnName(int index, java.lang.String name) Set the name for a column The name must correspond with a column with data.
void	setColumnText(int index, java.lang.String text) Set the text for a column.
void	setColumnTitle(int index, java.lang.String title) Set the title for a column.
void	setColumnWidth(int index, int width) Set a fixed width for a column.
void	setDataTransferAllowedEffect(java.lang.String allowedEffect) Specify which drag operations are allowed for the items in this dataconnector.
void	setDataTransferDropEffect(java.lang.String dropEffect) Specify which drop operations are allowed for the items in this dataconnector.
void	setShowHeader(boolean showHeader) Specify whether a header row is displayed on top of the grid.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataConnector.Options

protected DataConnector.Options()

Constructor

Method Detail

create

public static DataConnector.Options create()

Create a Javascript object instance of Options()

Returns:

new instance of Object

setDataTransferAllowedEffect

public final void setDataTransferAllowedEffect(java.lang.String allowedEffect)

Specify which drag operations are allowed for the items in this dataconnector.

Parameters:

allowedEffect - Available values are 'copy', 'move', 'link', 'copyLink', 'copyMove', 'linkMove', 'all', 'none'.

setDataTransferDropEffect

public final void setDataTransferDropEffect(java.lang.String dropEffect)

Specify which drop operations are allowed for the items in this dataconnector.

Parameters:

dropEffect - Available values are 'copy', 'move', 'link', 'none'

setShowHeader

public final void setShowHeader(boolean showHeader)

Specify whether a header row is displayed on top of the grid.

Parameters:

showHeader - If true (default), the header will be displayed

setColumnName

public final void setColumnName(int index,
                 java.lang.String name)

Set the name for a column The name must correspond with a column with data.

Parameters:

index - zero based column index

name -

setColumnText

public final void setColumnText(int index,
                 java.lang.String text)

Set the text for a column. The text will be displayed in the header of the grid

Parameters:

index - zero based column index

text -

setColumnTitle

public final void setColumnTitle(int index,
                  java.lang.String title)

Set the title for a column. Title will be shown when hovering the mouse over the header of this column.

Parameters:

index - zero based column index

title -

setColumnWidth

public final void setColumnWidth(int index,
                  int width)

Set a fixed width for a column.

Parameters:

index - zero based column index

width - width in pixels

setColumnFormat

public final void setColumnFormat(int index,
                   java.lang.String format)

Set a format function for a column to format the output. for example: format = "function () {return this.firstname + ' ' + this.lastname;}" WARNING: Evaluating a string in javscript is unsafe, it is recommended to a native JavaScript function instead.

Parameters:

index - zero based column index

format - string containing a javascript format function

setColumnFormat

public final void setColumnFormat(int index,
                   JavaScriptObject format)

Set a format function for a column to format the output. for example: format = function () {return this.firstname + ' ' + this.lastname;}

Parameters:

index - zero based column index

format - a javascript function

setColumn

public final void setColumn(int index,
             java.lang.String name,
             java.lang.String text,
             java.lang.String title)

Set name, text, and tile for a column.

Parameters:

index -

name -

text -

title -