com.google.gwt.user.cellview.client

Class CellBrowser

java.lang.Object

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

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

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

com.google.gwt.user.cellview.client.AbstractCellTree

com.google.gwt.user.cellview.client.CellBrowser

All Implemented Interfaces:

HasAttachHandlers, HasCloseHandlers<TreeNode>, HasOpenHandlers<TreeNode>, HasHandlers, HasKeyboardSelectionPolicy, EventListener, HasAnimation, HasVisibility, IsRenderable, IsWidget, ProvidesResize, RequiresResize

public class CellBrowser
extends AbstractCellTree
implements ProvidesResize, RequiresResize, HasAnimation

A "browsable" view of a tree in which only a single node per level may be open at one time.

This widget will only work in standards mode, which requires that the HTML page in which it is run have an explicit <!DOCTYPE> declaration.

Example

Trivial example

Complex example

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CellBrowser.Builder<T> Builder object to create CellBrowser.
static interface	CellBrowser.PagerFactory Pager factory used to create pagers for each CellList of the CellBrowser.
static interface	CellBrowser.Resources A ClientBundle that provides images for this widget.
static interface	CellBrowser.Style Styles used by this widget.

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.cellview.client.HasKeyboardSelectionPolicy

HasKeyboardSelectionPolicy.KeyboardSelectionPolicy

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CellBrowser(CellBrowser.Builder<T> builder)
	CellBrowser(TreeViewModel viewModel, T rootValue) Deprecated. please use CellBrowser.Builder
	CellBrowser(TreeViewModel viewModel, T rootValue, CellBrowser.Resources resources) Deprecated. please use CellBrowser.Builder

Method Summary

Modifier and Type	Method and Description
protected <C> Widget	createPager(HasData<C> display) Create a pager to control the list view.
int	getDefaultColumnWidth() Get the default width of new columns.
int	getMinimumColumnWidth() Get the minimum width of columns.
TreeNode	getRootTreeNode() Get the root TreeNode.
boolean	isAnimationEnabled() Returns true if animations are enabled, false if not.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onResize() This method must be called whenever the implementor's size has been modified.
void	setAnimationEnabled(boolean enable) Enable or disable animations.
void	setDefaultColumnWidth(int width) Set the default width of new columns.
void	setMinimumColumnWidth(int minWidth) Set the minimum width of columns.

Methods inherited from class com.google.gwt.user.cellview.client.AbstractCellTree

addCloseHandler, addOpenHandler, getKeyboardSelectionPolicy, getNodeInfo, getTreeViewModel, isKeyboardSelectionDisabled, isLeaf, setKeyboardSelectionPolicy

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

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

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

CellBrowser

@Deprecated
public CellBrowser(TreeViewModel viewModel,
                               T rootValue)

Deprecated. please use CellBrowser.Builder

Construct a new CellBrowser.

Type Parameters:

T - the type of data in the root node

Parameters:

viewModel - the TreeViewModel that backs the tree

rootValue - the hidden root value of the tree

CellBrowser

@Deprecated
public CellBrowser(TreeViewModel viewModel,
                               T rootValue,
                               CellBrowser.Resources resources)

Deprecated. please use CellBrowser.Builder

Construct a new CellBrowser with the specified CellBrowser.Resources.

Type Parameters:

T - the type of data in the root node

Parameters:

viewModel - the TreeViewModel that backs the tree

rootValue - the hidden root value of the tree

resources - the CellBrowser.Resources used for images

CellBrowser

protected CellBrowser(CellBrowser.Builder<T> builder)

Method Detail

getDefaultColumnWidth

public int getDefaultColumnWidth()

Get the default width of new columns.

Returns:

the default width in pixels

See Also:

setDefaultColumnWidth(int)

getMinimumColumnWidth

public int getMinimumColumnWidth()

Get the minimum width of columns.

Returns:

the minimum width in pixels

See Also:

setMinimumColumnWidth(int)

getRootTreeNode

public TreeNode getRootTreeNode()

Description copied from class: AbstractCellTree

Get the root TreeNode.

Specified by:

getRootTreeNode in class AbstractCellTree

Returns:

the TreeNode at the root of the tree

isAnimationEnabled

public boolean isAnimationEnabled()

Description copied from interface: HasAnimation

Returns true if animations are enabled, false if not.

Specified by:

isAnimationEnabled in interface HasAnimation

onBrowserEvent

public void onBrowserEvent(Event event)

Description copied from interface: EventListener

Fired whenever a browser event is received.

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Composite

Parameters:

event - the event received

onResize

public void onResize()

Description copied from interface: RequiresResize

This method must be called whenever the implementor's size has been modified.

Specified by:

onResize in interface RequiresResize

setAnimationEnabled

public void setAnimationEnabled(boolean enable)

Description copied from interface: HasAnimation

Enable or disable animations.

Specified by:

setAnimationEnabled in interface HasAnimation

Parameters:

enable - true to enable, false to disable

setDefaultColumnWidth

public void setDefaultColumnWidth(int width)

Set the default width of new columns.

Parameters:

width - the default width in pixels

See Also:

getDefaultColumnWidth()

setMinimumColumnWidth

public void setMinimumColumnWidth(int minWidth)

Set the minimum width of columns.

Parameters:

minWidth - the minimum width in pixels

See Also:

getMinimumColumnWidth()

createPager

protected <C> Widget createPager(HasData<C> display)

Create a pager to control the list view.

Type Parameters:

C - the item type in the list view

Parameters:

display - the list view to add paging too

Returns:

the pager