org.gwt.advanced.client.ui.widget

Class GridPanel

java.lang.Object

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

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

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.google.gwt.user.client.ui.CellPanel

com.google.gwt.user.client.ui.VerticalPanel

org.gwt.advanced.client.ui.widget.GridPanel

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.HasAlignment, com.google.gwt.user.client.ui.HasHorizontalAlignment, com.google.gwt.user.client.ui.HasVerticalAlignment, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.InsertPanel, com.google.gwt.user.client.ui.InsertPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, Iterable<com.google.gwt.user.client.ui.Widget>, AdvancedWidget, Resizable

public class GridPanel
extends com.google.gwt.user.client.ui.VerticalPanel
implements AdvancedWidget, Resizable

This is a grid panel widget.

It also helps to displayActive an editable grid with pagers and toolbars. Use it to construct the grid and displayActive it.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GridPanel.WindowResizeHandler This handler is invoked every time when anything makes the window to be resized.

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

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

com.google.gwt.user.client.ui.HasHorizontalAlignment.AutoHorizontalAlignmentConstant, com.google.gwt.user.client.ui.HasHorizontalAlignment.HorizontalAlignmentConstant

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

com.google.gwt.user.client.ui.HasVerticalAlignment.VerticalAlignmentConstant

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Fields inherited from interface com.google.gwt.user.client.ui.HasHorizontalAlignment

ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_JUSTIFY, ALIGN_LEFT, ALIGN_LOCALE_END, ALIGN_LOCALE_START, ALIGN_RIGHT

Fields inherited from interface com.google.gwt.user.client.ui.HasVerticalAlignment

ALIGN_BOTTOM, ALIGN_MIDDLE, ALIGN_TOP

Constructor Summary

Constructors

Constructor and Description
GridPanel() Constructs a new GridPanel.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addChildGridPanel(GridPanel child) This method adds a child grid panel.
void	addGridListener(GridListener listener) This method adds a new grid listener to be invoked on grid events.
void	addPagerListener(PagerListener pagerListener) This method adds a new pager listener.
void	addSelectRowListener(SelectRowListener listener) This method adds a new listener that is invoked on row selection.
void	addToolbarListener(GridToolbarListener gridToolbarListener) This method adds a toolbar listener to the toolbars.
protected void	adjust() Makes the widget take as much space as possible inside a parent element and resizes the nested grid.
EditableGrid	createEditableGrid(String[] headers, Class[] columnWidgetClasses, Editable model) Creates and adds a new editable grid into the panel.
EditableGrid	createEditableGrid(String[] headers, Class[] columnWidgetClasses, Editable model, boolean resizable) Creates and adds a new editable grid into the panel.
void	display() This method displays the panel and adds nested widgets.
Pager	getBottomPager() Getter for property 'bottomPager'.
com.google.gwt.user.client.ui.Panel	getBottomPanel() Getter for property 'bottomPanel'.
GridToolbar	getBottomToolbar() Getter for property 'bottomToolbar'.
List<GridPanel>	getChildGridPanels() This method returns a list of child grid panels.
int	getCurrentRow() Gets a currently selected row number.
protected com.google.gwt.user.client.ui.FocusPanel	getFocusPanel() Getter for property 'focusPanel'.
EditableGrid	getGrid() Getter for property 'grid'.
GridEventManager	getGridEventManager() Getter for property 'gridEventManager'.
protected LockingPanel	getLockingPanel() Getter for property 'lockingPanel'.
EventMediator	getMediator() Getter for property 'mediator'.
protected List<PagerListener>	getPagerListeners() Getter for property 'pagerListeners'.
protected GridPanel	getParentGridPanel() Getter for property 'parentGridPanel'.
protected com.google.gwt.event.logical.shared.ResizeHandler	getResizeHandler() Getter for property 'resizeHandler'.
protected List<GridToolbarListener>	getToolbarListeners() Getter for property 'toolbarListeners'.
Pager	getTopPager() Getter for property 'topPager'.
com.google.gwt.user.client.ui.Panel	getTopPanel() Getter for property 'topPanel'.
GridToolbar	getTopToolbar() Getter for property 'topToolbar'.
boolean	isArrowsVisible() Getter for property 'arrowsVisible'.
boolean	isAscending(int column) Checks whether the column is sorted ascending.
boolean	isBottomPagerVisible() Getter for property 'bottomPagerVisible'.
boolean	isBottomToolbarVisible() Getter for property 'bottomToolbarVisible'.
boolean	isResizable() Gets a flag that is responsible for column resisability.
boolean	isSortable(int column) Checks whether th column in the grid is sortable.
boolean	isTopPagerVisible() Getter for property 'topPagerVisible'.
boolean	isTopToolbarVisible() Getter for property 'topToolbarVisible'.
void	lock() This method locks the widget and refuses any user activities.
protected void	packBottomPanel() This method displays a bottom panel and adds a bottom pager and toolbar into it.
protected void	packGrid() This method adds a grid into the panel.
protected void	packTopPanel() This method displays a top panel and adds top pager and toolbar into it.
protected Pager	preparePager(Pager pager, com.google.gwt.user.client.ui.Panel panel) This method initializes a pager with common values.
protected GridToolbar	prepareToolbar(GridToolbar toolbar, com.google.gwt.user.client.ui.Panel panel) This method initializes a toolbar with common values.
protected void	removeChildGridPanel(GridPanel child) This method removes a child grid panel.
void	removeGridListener(GridListener listener) This method removes the specified grid listener.
void	removeSelectRowListener(SelectRowListener listener) This method removes the specified row selection listener.
void	resize() This method resizes nested components to make them fix as much space as possible.
void	setArrowsVisible(boolean visible) Setter for property 'arrowsVisible'.
void	setAscending(boolean ascending) Sets the acsending / descending order of sorting.
protected void	setBottomPager(Pager bottomPager) Setter for property 'bottomPager'.
void	setBottomPagerVisible(boolean bottomPagerVisible) Setter for property 'bottomPagerVisible'.
protected void	setBottomPanel(com.google.gwt.user.client.ui.Panel bottomPanel) Setter for property 'bottomPanel'.
protected void	setBottomToolbar(GridToolbar bottomToolbar) Setter for property 'bottomToolbar'.
void	setBottomToolbarVisible(boolean bottomToolbarVisible) Setter for property 'bottomToolbarVisible'.
protected void	setGrid(EditableGrid grid) Setter for property 'grid'.
void	setGridEventManager(GridEventManager gridEventManager) Setter for property 'gridEventManager'.
void	setGridFocus(boolean focus) This method sets focus to the grid.
void	setInvisibleColumn(int column, boolean invisible) This method sets the specified column
void	setMultiRowModeEnabled(boolean enabled) Enables or disables the multi-row selection mode.
void	setPageNumberBoxDisplayed(boolean value) Sets the page number boxes visible.
void	setParent(GridPanel panel) Setter for property 'parent'.
void	setReadonlyColumn(int column, boolean readonly) Makes the specified column to be readonly.
void	setResizable(boolean resizable) Sets a flag value that means whether the grid columns will be resizable.
void	setSortableColumn(int column, boolean sortable) Makes the specified column to be sortable.
void	setSortColumn(int column) Sets the sort column.
protected void	setTopPager(Pager topPager) Setter for property 'topPager'.
void	setTopPagerVisible(boolean topPagerVisible) Setter for property 'topPagerVisible'.
protected void	setTopPanel(com.google.gwt.user.client.ui.Panel topPanel) Setter for property 'topPanel'.
protected void	setTopToolbar(GridToolbar topToolbar) Setter for property 'topToolbar'.
void	setTopToolbarVisible(boolean topToolbarVisible) Setter for property 'topToolbarVisible'.
void	setTotalCountDisplayed(boolean value) Sets the page count label visible.
void	unlock() This method unlocks the widget and repaints it.
void	unlock(TreeGridRow parent) This method unlocks the subtree and repaints it.

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

add, getHorizontalAlignment, getVerticalAlignment, insert, insert, onEnsureDebugId, remove, setHorizontalAlignment, setVerticalAlignment

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

getBody, getSpacing, getTable, setBorderWidth, setCellHeight, setCellHeight, setCellHorizontalAlignment, setCellHorizontalAlignment, setCellHorizontalAlignment, setCellVerticalAlignment, setCellVerticalAlignment, setCellVerticalAlignment, setCellWidth, setCellWidth, setSpacing

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

add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove

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

add, adopt, adopt, clear, disown, doAttachChildren, doDetachChildren, orphan, remove

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

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, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Constructor Detail

GridPanel

public GridPanel()

Constructs a new GridPanel.

Method Detail

createEditableGrid

public EditableGrid createEditableGrid(String[] headers,
                              Class[] columnWidgetClasses,
                              Editable model)

Creates and adds a new editable grid into the panel.

Use this method before display().

Parameters:

headers - is a list of heder labels.

columnWidgetClasses - is a list of column widget classes.

model - is a data model to be applied in the grid.

Returns:

a newly created grid.

createEditableGrid

public EditableGrid createEditableGrid(String[] headers,
                              Class[] columnWidgetClasses,
                              Editable model,
                              boolean resizable)

Creates and adds a new editable grid into the panel.

Use this method before display(). It automatically detects a type of the new grid by the type of the model.

Parameters:

headers - is a list of heder labels.

columnWidgetClasses - is a list of column widget classes.

model - is a data model to be applied in the grid.

resizable - is a columns resizability flag value.

Returns:

a newly created grid.

setReadonlyColumn

public void setReadonlyColumn(int column,
                     boolean readonly)

Makes the specified column to be readonly.

Use this method before display().

Parameters:

column - is a column number.

readonly - is a readonly attribute value.

setSortableColumn

public void setSortableColumn(int column,
                     boolean sortable)

Makes the specified column to be sortable.

Use this method before display().

Parameters:

column - is a column number.

sortable - is a sortable attribute value.

setInvisibleColumn

public void setInvisibleColumn(int column,
                      boolean invisible)

This method sets the specified column

Parameters:

column - is a column number.

invisible - is a flag to switch the column to invisible state.

setArrowsVisible

public void setArrowsVisible(boolean visible)

Setter for property 'arrowsVisible'.

Parameters:

visible - Value to set for property 'arrowsVisible'.

setPageNumberBoxDisplayed

public void setPageNumberBoxDisplayed(boolean value)

Sets the page number boxes visible.

Parameters:

value - is a flag value.

setTotalCountDisplayed

public void setTotalCountDisplayed(boolean value)

Sets the page count label visible.

Parameters:

value - is a value to be set.

display

public void display()

This method displays the panel and adds nested widgets.

Specified by:

display in interface AdvancedWidget

lock

public void lock()

This method locks the widget and refuses any user activities.

unlock

public void unlock()

This method unlocks the widget and repaints it.

unlock

public void unlock(TreeGridRow parent)

This method unlocks the subtree and repaints it.

Use this unlocking method only if the TreeDataModelCallbackHandler.synchronize( org.gwt.advanced.client.datamodel.LazyTreeGridRow, Composite ) method has been invoked. Otherwise use the unlock() method instead.

Parameters:

parent - is a parent row of the subtree.

getMediator

public EventMediator getMediator()

Getter for property 'mediator'.

Returns:

Value for property 'mediator'.

isTopPagerVisible

public boolean isTopPagerVisible()

Getter for property 'topPagerVisible'.

Returns:

Value for property 'topPagerVisible'.

setTopPagerVisible

public void setTopPagerVisible(boolean topPagerVisible)

Setter for property 'topPagerVisible'.

Parameters:

topPagerVisible - Value to set for property 'topPagerVisible'.

isBottomPagerVisible

public boolean isBottomPagerVisible()

Getter for property 'bottomPagerVisible'.

Returns:

Value for property 'bottomPagerVisible'.

setBottomPagerVisible

public void setBottomPagerVisible(boolean bottomPagerVisible)

Setter for property 'bottomPagerVisible'.

Parameters:

bottomPagerVisible - Value to set for property 'bottomPagerVisible'.

isTopToolbarVisible

public boolean isTopToolbarVisible()

Getter for property 'topToolbarVisible'.

Returns:

Value for property 'topToolbarVisible'.

setTopToolbarVisible

public void setTopToolbarVisible(boolean topToolbarVisible)

Setter for property 'topToolbarVisible'.

Parameters:

topToolbarVisible - Value to set for property 'topToolbarVisible'.

isBottomToolbarVisible

public boolean isBottomToolbarVisible()

Getter for property 'bottomToolbarVisible'.

Returns:

Value for property 'bottomToolbarVisible'.

setBottomToolbarVisible

public void setBottomToolbarVisible(boolean bottomToolbarVisible)

Setter for property 'bottomToolbarVisible'.

Parameters:

bottomToolbarVisible - Value to set for property 'bottomToolbarVisible'.

isArrowsVisible

public boolean isArrowsVisible()

Getter for property 'arrowsVisible'.

Returns:

Value for property 'arrowsVisible'.

getGrid

public EditableGrid getGrid()

Getter for property 'grid'.

Returns:

Value for property 'grid'.

getTopPager

public Pager getTopPager()

Getter for property 'topPager'.

Returns:

Value for property 'topPager'.

getTopToolbar

public GridToolbar getTopToolbar()

Getter for property 'topToolbar'.

Returns:

Value for property 'topToolbar'.

getBottomPager

public Pager getBottomPager()

Getter for property 'bottomPager'.

Returns:

Value for property 'bottomPager'.

getBottomToolbar

public GridToolbar getBottomToolbar()

Getter for property 'bottomToolbar'.

Returns:

Value for property 'bottomToolbar'.

getTopPanel

public com.google.gwt.user.client.ui.Panel getTopPanel()

Getter for property 'topPanel'.

Returns:

Value for property 'topPanel'.

getBottomPanel

public com.google.gwt.user.client.ui.Panel getBottomPanel()

Getter for property 'bottomPanel'.

Returns:

Value for property 'bottomPanel'.

setParent

public void setParent(GridPanel panel)

Setter for property 'parent'.

Parameters:

panel - Value to set for property 'parent'.

isSortable

public boolean isSortable(int column)

Checks whether th column in the grid is sortable.

Parameters:

column - is a column to check.

Returns:

a result of check.

isAscending

public boolean isAscending(int column)

Checks whether the column is sorted ascending.

Parameters:

column - is a column number.

Returns:

a result of check.

setAscending

public void setAscending(boolean ascending)

Sets the acsending / descending order of sorting.

Note that this method also redisplays the grid. If you don't want to redisplay it you should use model methods instead.

Parameters:

ascending - is an order of sorting. true means ascending.

setSortColumn

public void setSortColumn(int column)

Sets the sort column.

Note that this method also redisplays the grid. If you don't want to redisplay it you should use model methods instead.

Parameters:

column - is a column number.

getCurrentRow

public int getCurrentRow()

Gets a currently selected row number.

Returns:

is a current row number.

isResizable

public boolean isResizable()

Gets a flag that is responsible for column resisability.

Returns:

true means that columns of the grid must be resizable.

setResizable

public void setResizable(boolean resizable)

Sets a flag value that means whether the grid columns will be resizable.

This method also switches on / off table-layout style.

Parameters:

resizable - is a flag value.

getGridEventManager

public GridEventManager getGridEventManager()

Getter for property 'gridEventManager'.

Returns:

Value for property 'gridEventManager'.

setGridEventManager

public void setGridEventManager(GridEventManager gridEventManager)

Setter for property 'gridEventManager'.

Parameters:

gridEventManager - Value to set for property 'gridEventManager'.

resize

public void resize()

This method resizes nested components to make them fix as much space as possible.

Specified by:

resize in interface Resizable

addSelectRowListener

public void addSelectRowListener(SelectRowListener listener)

This method adds a new listener that is invoked on row selection.

Parameters:

listener - is a listener to be invoked.

removeSelectRowListener

public void removeSelectRowListener(SelectRowListener listener)

This method removes the specified row selection listener.

Parameters:

listener - is a listener to remove.

setMultiRowModeEnabled

public void setMultiRowModeEnabled(boolean enabled)

Enables or disables the multi-row selection mode.

Parameters:

enabled - true means that this grid will allow multiple row selection.

addGridListener

public void addGridListener(GridListener listener)

This method adds a new grid listener to be invoked on grid events.

Parameters:

listener - is a listener to add.

removeGridListener

public void removeGridListener(GridListener listener)

This method removes the specified grid listener.

Parameters:

listener - is a listener to remove.

adjust

protected void adjust()

Makes the widget take as much space as possible inside a parent element and resizes the nested grid.

getResizeHandler

protected com.google.gwt.event.logical.shared.ResizeHandler getResizeHandler()

Getter for property 'resizeHandler'.

Returns:

Value for property 'resizeHandler'.

packTopPanel

protected void packTopPanel()

This method displays a top panel and adds top pager and toolbar into it.

packGrid

protected void packGrid()

This method adds a grid into the panel.

packBottomPanel

protected void packBottomPanel()

This method displays a bottom panel and adds a bottom pager and toolbar into it.

prepareToolbar

protected GridToolbar prepareToolbar(GridToolbar toolbar,
                         com.google.gwt.user.client.ui.Panel panel)

This method initializes a toolbar with common values.

Parameters:

toolbar - is a toolbar to be initialized.

panel - is a top or bottom panel.

Returns:

an initialized toolbar.

preparePager

protected Pager preparePager(Pager pager,
                 com.google.gwt.user.client.ui.Panel panel)

This method initializes a pager with common values.

Parameters:

pager - is a pager to be initialized.

panel - is a top or bottom panel.

Returns:

an initialized toolbar.

setBottomPanel

protected void setBottomPanel(com.google.gwt.user.client.ui.Panel bottomPanel)

Setter for property 'bottomPanel'.

Parameters:

bottomPanel - Value to set for property 'bottomPanel'.

setTopPanel

protected void setTopPanel(com.google.gwt.user.client.ui.Panel topPanel)

Setter for property 'topPanel'.

Parameters:

topPanel - Value to set for property 'topPanel'.

setTopPager

protected void setTopPager(Pager topPager)

Setter for property 'topPager'.

Parameters:

topPager - Value to set for property 'topPager'.

setGrid

protected void setGrid(EditableGrid grid)

Setter for property 'grid'.

Parameters:

grid - Value to set for property 'grid'.

setTopToolbar

protected void setTopToolbar(GridToolbar topToolbar)

Setter for property 'topToolbar'.

Parameters:

topToolbar - Value to set for property 'topToolbar'.

setBottomPager

protected void setBottomPager(Pager bottomPager)

Setter for property 'bottomPager'.

Parameters:

bottomPager - Value to set for property 'bottomPager'.

setBottomToolbar

protected void setBottomToolbar(GridToolbar bottomToolbar)

Setter for property 'bottomToolbar'.

Parameters:

bottomToolbar - Value to set for property 'bottomToolbar'.

getToolbarListeners

protected List<GridToolbarListener> getToolbarListeners()

Getter for property 'toolbarListeners'.

Returns:

Value for property 'toolbarListeners'.

getPagerListeners

protected List<PagerListener> getPagerListeners()

Getter for property 'pagerListeners'.

Returns:

Value for property 'pagerListeners'.

addToolbarListener

public void addToolbarListener(GridToolbarListener gridToolbarListener)

This method adds a toolbar listener to the toolbars.

Parameters:

gridToolbarListener - is a toolbar listener.

addPagerListener

public void addPagerListener(PagerListener pagerListener)

This method adds a new pager listener.

Parameters:

pagerListener - is a pager listener.

setGridFocus

public void setGridFocus(boolean focus)

This method sets focus to the grid.

Parameters:

focus - is a focus flag value.

getLockingPanel

protected LockingPanel getLockingPanel()

Getter for property 'lockingPanel'.

Returns:

Value for property 'lockingPanel'.

getParentGridPanel

protected GridPanel getParentGridPanel()

Getter for property 'parentGridPanel'.

Returns:

Value for property 'parentGridPanel'.

getChildGridPanels

public List<GridPanel> getChildGridPanels()

This method returns a list of child grid panels.

Returns:

a list of grid panels.

getFocusPanel

protected com.google.gwt.user.client.ui.FocusPanel getFocusPanel()

Getter for property 'focusPanel'.

Returns:

Value for property 'focusPanel'.

addChildGridPanel

protected void addChildGridPanel(GridPanel child)

This method adds a child grid panel.

Parameters:

child - is a child panel.

removeChildGridPanel

protected void removeChildGridPanel(GridPanel child)

This method removes a child grid panel.

Parameters:

child - a child grid panel.