edu.ucdavis.cstars.client.dijits

Class TemplatePicker

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Composite

edu.ucdavis.cstars.client.dijits.TemplatePicker

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsRenderable, com.google.gwt.user.client.ui.IsWidget

public class TemplatePicker
extends com.google.gwt.user.client.ui.Composite

A template picker displays a gallery of templates from one or more feature layers. For each template, a symbol and a label is displayed. Users can select or deselect a symbol by clicking on the item.

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplatePicker.Parameters
static class	TemplatePicker.SelectedFeatureLayer
static class	TemplatePicker.SelectedItem

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
TemplatePicker(TemplatePicker.Parameters params) Creates a new TemplatePicker object that displays a gallery of templates from the input feature layers or items.

Method Summary

Methods

Modifier and Type	Method and Description
void	addSelectionChangeHandler(SelectionChangeHandler handler)
static boolean	assertLoaded() Check that the esri.dijit.TemplatePicker package has been loaded
void	clearSelection() Clears the current selection.
void	destroy() Destroys the template picker.
com.google.gwt.core.client.JavaScriptObject	getGrid() Reference to the data grid used to display the templates.
com.google.gwt.core.client.JavaScriptObject	getSelected() Gets the selected item picked by the user.
TemplatePicker.SelectedFeatureLayer	getSelectedFeatureLayer() Gets the selected item picked by the user.
TemplatePicker.SelectedItem	getSelectedItem() Gets the selected item picked by the user.
com.google.gwt.dom.client.Element	getTooltip() If tooltips are enabled the reference to the tooltip div.
void	setAttribute(java.lang.String name, boolean value) set the properties of the template picker.
void	setAttribute(java.lang.String name, int value) set the properties of the template picker.
void	startup() Finalizes the creation of the template picker.
void	update() Updates the templatePicker after modifying the properties of the widget.

Methods inherited from class com.google.gwt.user.client.ui.Composite

claimElement, initializeClaimedElement, isAttached, onBrowserEvent, render, render

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, fireEvent, getLayoutData, getParent, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, isVisible, removeStyleDependentName, removeStyleName, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TemplatePicker

public TemplatePicker(TemplatePicker.Parameters params)

Creates a new TemplatePicker object that displays a gallery of templates from the input feature layers or items. A symbol and label is displayed for each template. The symbol is defined by the template's feature type. The label is the template's name.

Parameters:

params - - FeatureLayers or items are required all other parameters are optional. See options list.

Method Detail

assertLoaded

public static boolean assertLoaded()

Check that the esri.dijit.TemplatePicker package has been loaded

Returns:

boolean

getGrid

public final com.google.gwt.core.client.JavaScriptObject getGrid()

Reference to the data grid used to display the templates.

Returns:

JavaScriptObject

getTooltip

public final com.google.gwt.dom.client.Element getTooltip()

If tooltips are enabled the reference to the tooltip div.

Returns:

Element

setAttribute

public final void setAttribute(java.lang.String name,
                boolean value)

set the properties of the template picker.

Parameters:

name - - Name of the attribute of interest.

value - - Value for the specified attribute.

setAttribute

public final void setAttribute(java.lang.String name,
                int value)

set the properties of the template picker.

Parameters:

name - - Name of the attribute of interest.

value - - Value for the specified attribute.

clearSelection

public final void clearSelection()

Clears the current selection.

destroy

public void destroy()

Destroys the template picker. Call destroy() when the widget is no longer needed by the application.

getSelected

public final com.google.gwt.core.client.JavaScriptObject getSelected()

Gets the selected item picked by the user.

Returns:

JavaScriptObject

getSelectedFeatureLayer

public final TemplatePicker.SelectedFeatureLayer getSelectedFeatureLayer()

Gets the selected item picked by the user.

Returns:

JavaScriptObject

getSelectedItem

public final TemplatePicker.SelectedItem getSelectedItem()

Gets the selected item picked by the user.

Returns:

JavaScriptObject

startup

public final void startup()

Finalizes the creation of the template picker. Call startup() after creating the widget when you are ready for user interaction.

update

public final void update()

Updates the templatePicker after modifying the properties of the widget.

addSelectionChangeHandler

public final void addSelectionChangeHandler(SelectionChangeHandler handler)

Parameters:

handler - - Fires when an item is selected or unselected in the template picker. You can retrieve the selected item using the getSelected() method.