edu.ucdavis.cstars.client.dijits

Class TemplatePicker.Parameters

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.dijits.TemplatePicker.Parameters

Enclosing class:

TemplatePicker

public static class TemplatePicker.Parameters
extends com.google.gwt.core.client.JavaScriptObject

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(java.lang.String label, Symbol symbol, java.lang.String description) Add to array of items.
static TemplatePicker.Parameters	create()
void	setAutoColumns() Specify "auto" to have the template picker automatically calculate the number of columns based on the number of rows.
void	setAutoRows() Specify "auto" to have the template picker automatically calculate the number of rows based on the number of columns.
void	setColumns(int columns)
void	setFeatureLayers(FeatureLayer[] featureLayers)
void	setGrouping(boolean grouping) Templates are grouped based on the containing feature layer.
void	setMaxLabelLength(int maxLabelLength)
void	setRows(int rows)
void	setStyle(java.lang.String style)
void	showTooltip(boolean showTooltip)

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static TemplatePicker.Parameters create()

setAutoColumns

public final void setAutoColumns()

Specify "auto" to have the template picker automatically calculate the number of columns based on the number of rows. Note: "auto" has no effect when grouping is enabled.

setColumns

public final void setColumns(int columns)

Parameters:

columns - - Number of visible columns. Default is three.

setFeatureLayers

public final void setFeatureLayers(FeatureLayer[] featureLayers)

Parameters:

featureLayers - - Array of input feature layers. The template picker displays the templates from each of the layer's in the array. Required to provide either featureLayers or items.

setGrouping

public final void setGrouping(boolean grouping)

Templates are grouped based on the containing feature layer. Grouping is automatically disabled when items are specified instead of featureLayers.

Parameters:

grouping - - Default is true.

addItem

public final void addItem(java.lang.String label,
           Symbol symbol,
           java.lang.String description)

Add to array of items. Use this option if you want to display a collection of symbols in the template picker.

Parameters:

label -

symbol -

description -

setMaxLabelLength

public final void setMaxLabelLength(int maxLabelLength)

Parameters:

maxLabelLength - - Length of label description. Default is to display the entire label. If the specified maxLabelLength is less than the number of characters in the label description the description is truncated.

setAutoRows

public final void setAutoRows()

Specify "auto" to have the template picker automatically calculate the number of rows based on the number of columns. Note: "auto" has no effect when grouping is enabled.

setRows

public final void setRows(int rows)

Parameters:

rows - - Number of visible rows. Default is four.

showTooltip

public final void showTooltip(boolean showTooltip)

Parameters:

showTooltip - - Tooltip content contains the template name and description. Default is false.

setStyle

public final void setStyle(java.lang.String style)

Parameters:

style - - HTML style attributes for the widget. Specify as css text