org.gwt.advanced.client.ui.widget.GridPanel Maven / Gradle / Ivy
Show all versions of advanced-gwt Show documentation
/*
* Copyright 2008-2012 Sergey Skladchikov
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gwt.advanced.client.ui.widget;
import com.google.gwt.event.logical.shared.ResizeEvent;
import com.google.gwt.event.logical.shared.ResizeHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.Element;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.ui.FocusPanel;
import com.google.gwt.user.client.ui.Panel;
import com.google.gwt.user.client.ui.VerticalPanel;
import org.gwt.advanced.client.datamodel.Composite;
import org.gwt.advanced.client.datamodel.Editable;
import org.gwt.advanced.client.datamodel.Hierarchical;
import org.gwt.advanced.client.datamodel.TreeGridRow;
import org.gwt.advanced.client.ui.*;
import org.gwt.advanced.client.util.GWTUtil;
import java.util.ArrayList;
import java.util.List;
/**
* 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.
*
* @author Sergey Skladchikov
* @since 1.0.0
*/
public class GridPanel extends VerticalPanel implements AdvancedWidget, Resizable {
/** an editable grid */
private EditableGrid grid;
/** a top pager */
private Pager topPager;
/** a bottom pager */
private Pager bottomPager;
/** a bottom toolbar */
private GridToolbar bottomToolbar;
/** a top toolbar */
private GridToolbar topToolbar;
/** a top panel */
private Panel topPanel;
/** a bottom panel */
private Panel bottomPanel;
/** top pager visibility flag */
private boolean topPagerVisible = true;
/** bottom pager visibility flag */
private boolean bottomPagerVisible = true;
/** top toolbar visibility flag */
private boolean topToolbarVisible = true;
/** bottom toolbar visibility flag */
private boolean bottomToolbarVisible = false;
/** pager arrows visibility flag */
private boolean arrowsVisible = true;
/** toolbar listeners */
private List toolbarListeners = new ArrayList();
/** pager listeners */
private List pagerListeners = new ArrayList();
/** locking panel widget */
private LockingPanel lockingPanel;
/** a mediator to handle all component events inside the panel */
private EventMediator mediator;
/** a parent grid panel */
private GridPanel parentGridPanel;
/** a list of child grid panels */
private List children;
/** a panel that handles key events */
private FocusPanel focusPanel;
/** a grid key event manager instance */
private GridEventManager gridEventManager;
/** a handler to be invoked on window resize */
private ResizeHandler resizeHandler;
/** grid click handler registration */
private HandlerRegistration gridClickRegistration;
/** grid focus handler registration */
private HandlerRegistration gridFocusRegistration;
/** grid blur handler registration */
private HandlerRegistration gridBlurRegistration;
/** window resize handler registration */
private HandlerRegistration windowResizeRegistration;
/** Constructs a new GridPanel. */
public GridPanel() {
}
/**
* Creates and adds a new editable grid into the panel.
* Use this method before {@link #display()}.
*
* @param headers is a list of heder labels.
* @param columnWidgetClasses is a list of column widget classes.
* @param model is a data model to be applied in the grid.
* @return a newly created grid.
*/
public EditableGrid createEditableGrid(String[] headers, Class[] columnWidgetClasses, Editable model) {
return createEditableGrid(headers, columnWidgetClasses, model, true);
}
/**
* Creates and adds a new editable grid into the panel.
* Use this method before {@link #display()}. It automatically detects a type of the new grid by the type of
* the model.
*
* @param headers is a list of heder labels.
* @param columnWidgetClasses is a list of column widget classes.
* @param model is a data model to be applied in the grid.
* @param resizable is a columns resizability flag value.
* @return a newly created grid.
*/
@SuppressWarnings({"unchecked"})
public EditableGrid createEditableGrid(String[] headers, Class[] columnWidgetClasses, Editable model, boolean resizable) {
EditableGrid grid;
if (model instanceof Hierarchical)
grid = new HierarchicalGrid(headers, columnWidgetClasses, resizable);
else if (model instanceof Composite)
grid = new TreeGrid(headers, columnWidgetClasses, resizable);
else
grid = new EditableGrid(headers, columnWidgetClasses, resizable);
grid.setGridPanel(this);
grid.setModel(model);
if (model instanceof Hierarchical)
setGridEventManager(new HierarchicalGridEventManager(this));
return grid;
}
/**
* Makes the specified column to be readonly.
* Use this method before {@link #display()}.
*
* @param column is a column number.
* @param readonly is a readonly attribute value.
*/
public void setReadonlyColumn(int column, boolean readonly) {
EditableGrid grid = getGrid();
if (grid != null) {
grid.setReadOnly(column, readonly);
}
}
/**
* Makes the specified column to be sortable.
* Use this method before {@link #display()}.
*
* @param column is a column number.
* @param sortable is a sortable attribute value.
*/
public void setSortableColumn(int column, boolean sortable) {
EditableGrid grid = getGrid();
if (grid != null) {
grid.setSortable(column, sortable);
}
}
/**
* This method sets the specified column
*
* @param column is a column number.
* @param invisible is a flag to switch the column to invisible state.
*/
public void setInvisibleColumn(int column, boolean invisible) {
EditableGrid grid = getGrid();
if (grid == null)
return;
if (invisible)
grid.addInvisibleColumn(column);
else
grid.removeInvisibleColumn(column);
}
/**
* Setter for property 'arrowsVisible'.
*
* @param visible Value to set for property 'arrowsVisible'.
*/
public void setArrowsVisible(boolean visible) {
this.arrowsVisible = visible;
}
/**
* Sets the page number boxes visible.
*
* @param value is a flag value.
*/
public void setPageNumberBoxDisplayed(boolean value) {
if (isTopPagerVisible())
getTopPager().setPageNumberBoxDisplayed(value);
if (isBottomPagerVisible())
getBottomPager().setPageNumberBoxDisplayed(value);
}
/**
* Sets the page count label visible.
*
* @param value is a value to be set.
*/
public void setTotalCountDisplayed(boolean value) {
if (isTopPagerVisible())
getTopPager().setTotalCountDisplayed(value);
if (isBottomPagerVisible())
getBottomPager().setTotalCountDisplayed(value);
}
/** This method displays the panel and adds nexted widgets. */
public void display() {
if (getGrid() == null)
throw new IllegalStateException("Grid hasn't been initialized");
setStyleName("advanced-GridPanel");
remove(getGrid());
remove(getTopPanel());
remove(getBottomPanel());
getMediator().addPagerListener(getMediator());
getMediator().addToolbarListener(getMediator());
getMediator().addGridListener(getMediator());
for (PagerListener listener : getPagerListeners())
getMediator().addPagerListener(listener);
for (GridToolbarListener toolbarListener : getToolbarListeners())
getMediator().addToolbarListener(toolbarListener);
if (gridClickRegistration != null) {
gridClickRegistration.removeHandler();
gridClickRegistration = null;
}
if (gridFocusRegistration != null) {
gridFocusRegistration.removeHandler();
gridFocusRegistration = null;
}
if (gridBlurRegistration != null) {
gridBlurRegistration.removeHandler();
gridBlurRegistration = null;
}
packTopPanel();
packGrid();
packBottomPanel();
gridClickRegistration = getGrid().addClickHandler(getGridEventManager());
gridFocusRegistration = getFocusPanel().addFocusHandler(getGridEventManager());
gridBlurRegistration = getFocusPanel().addBlurHandler(getGridEventManager());
if (windowResizeRegistration != null) {
windowResizeRegistration.removeHandler();
}
windowResizeRegistration = Window.addResizeHandler(getResizeHandler());
}
/** This method locks the widget and refuses any user activities. */
public void lock() {
getGrid().setLocked(true);
getLockingPanel().lock();
}
/** This method unlocks the widget and repaints it. */
public void unlock() {
Editable model = getGrid().getModel();
model.clearRemovedRows();
if (model.getTotalPagesNumber() <= model.getCurrentPageNumber()) {
int currentPageNumber = model.getTotalPagesNumber() - 1;
if (currentPageNumber >= 0)
model.setCurrentPageNumber(currentPageNumber);
else
model.setCurrentPageNumber(0);
if (isTopPagerVisible())
getTopPager().display();
if (isBottomPagerVisible())
getBottomPager().display();
}
getGrid().drawContent();
getLockingPanel().unlock();
getGrid().setLocked(false);
}
/**
* This method unlocks the subtree and repaints it.
* Use this unlocking method only if the
* {@link org.gwt.advanced.client.datamodel.TreeDataModelCallbackHandler#synchronize(
*org.gwt.advanced.client.datamodel.LazyTreeGridRow, Composite
*)
* } method has been invoked. Otherwise use the {@link #unlock()} method instead.
*
* @param parent is a parent row of the subtree.
*/
public void unlock(TreeGridRow parent) {
if (!(getGrid().getModel() instanceof Composite)) {
unlock();
return;
}
Composite model = (Composite) getGrid().getModel();
model.clearRemovedRows(parent);
getGrid().drawContent();
getLockingPanel().unlock();
getGrid().setLocked(false);
}
/**
* Getter for property 'mediator'.
*
* @return Value for property 'mediator'.
*/
public EventMediator getMediator() {
if (mediator == null)
mediator = new EventMediator(this);
return mediator;
}
/**
* Getter for property 'topPagerVisible'.
*
* @return Value for property 'topPagerVisible'.
*/
public boolean isTopPagerVisible() {
return topPagerVisible;
}
/**
* Setter for property 'topPagerVisible'.
*
* @param topPagerVisible Value to set for property 'topPagerVisible'.
*/
public void setTopPagerVisible(boolean topPagerVisible) {
this.topPagerVisible = topPagerVisible;
}
/**
* Getter for property 'bottomPagerVisible'.
*
* @return Value for property 'bottomPagerVisible'.
*/
public boolean isBottomPagerVisible() {
return bottomPagerVisible;
}
/**
* Setter for property 'bottomPagerVisible'.
*
* @param bottomPagerVisible Value to set for property 'bottomPagerVisible'.
*/
public void setBottomPagerVisible(boolean bottomPagerVisible) {
this.bottomPagerVisible = bottomPagerVisible;
}
/**
* Getter for property 'topToolbarVisible'.
*
* @return Value for property 'topToolbarVisible'.
*/
public boolean isTopToolbarVisible() {
return topToolbarVisible;
}
/**
* Setter for property 'topToolbarVisible'.
*
* @param topToolbarVisible Value to set for property 'topToolbarVisible'.
*/
public void setTopToolbarVisible(boolean topToolbarVisible) {
this.topToolbarVisible = topToolbarVisible;
}
/**
* Getter for property 'bottomToolbarVisible'.
*
* @return Value for property 'bottomToolbarVisible'.
*/
public boolean isBottomToolbarVisible() {
return bottomToolbarVisible;
}
/**
* Setter for property 'bottomToolbarVisible'.
*
* @param bottomToolbarVisible Value to set for property 'bottomToolbarVisible'.
*/
public void setBottomToolbarVisible(boolean bottomToolbarVisible) {
this.bottomToolbarVisible = bottomToolbarVisible;
}
/**
* Getter for property 'arrowsVisible'.
*
* @return Value for property 'arrowsVisible'.
*/
public boolean isArrowsVisible() {
return arrowsVisible;
}
/**
* Getter for property 'grid'.
*
* @return Value for property 'grid'.
*/
public EditableGrid getGrid() {
return grid;
}
/**
* Getter for property 'topPager'.
*
* @return Value for property 'topPager'.
*/
public Pager getTopPager() {
if (topPager == null)
setTopPager(new Pager());
return topPager;
}
/**
* Getter for property 'topToolbar'.
*
* @return Value for property 'topToolbar'.
*/
public GridToolbar getTopToolbar() {
if (topToolbar == null)
setTopToolbar(new GridToolbar());
return topToolbar;
}
/**
* Getter for property 'bottomPager'.
*
* @return Value for property 'bottomPager'.
*/
public Pager getBottomPager() {
if (bottomPager == null)
setBottomPager(new Pager());
return bottomPager;
}
/**
* Getter for property 'bottomToolbar'.
*
* @return Value for property 'bottomToolbar'.
*/
public GridToolbar getBottomToolbar() {
if (bottomToolbar == null)
setBottomToolbar(new GridToolbar());
return bottomToolbar;
}
/**
* Getter for property 'topPanel'.
*
* @return Value for property 'topPanel'.
*/
public Panel getTopPanel() {
if (topPanel == null) {
VerticalPanel verticalPanel = new VerticalPanel();
verticalPanel.setStyleName("top-panel");
setTopPanel(verticalPanel);
}
return topPanel;
}
/**
* Getter for property 'bottomPanel'.
*
* @return Value for property 'bottomPanel'.
*/
public Panel getBottomPanel() {
if (bottomPanel == null) {
VerticalPanel verticalPanel = new VerticalPanel();
verticalPanel.setStyleName("bottom-panel");
setBottomPanel(verticalPanel);
}
return bottomPanel;
}
/**
* Setter for property 'parent'.
*
* @param panel Value to set for property 'parent'.
*/
public void setParent(GridPanel panel) {
if (this.parentGridPanel != null)
this.parentGridPanel.removeChildGridPanel(this);
this.parentGridPanel = panel;
if (panel != null)
panel.addChildGridPanel(this);
}
/**
* Checks whether th column in the grid is sortable.
*
* @param column is a column to check.
* @return a result of check.
*/
public boolean isSortable(int column) {
return getGrid().isSortable(column);
}
/**
* Checks whether the column is sorted ascending.
*
* @param column is a column number.
* @return a result of check.
*/
public boolean isAscending(int column) {
return getGrid().isAscending(column);
}
/**
* 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.
*
* @param ascending is an order of sorting. true means ascending.
*/
public void setAscending(boolean ascending) {
getGrid().setAscending(ascending);
}
/**
* 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.
*
* @param column is a column number.
*/
public void setSortColumn(int column) {
getGrid().setSortColumn(column);
}
/**
* Gets a currently selected row number.
*
* @return is a current row number.
*/
public int getCurrentRow() {
return getGrid().getCurrentRow();
}
/**
* Gets a flag that is responsible for column resisability.
*
* @return true means that columns of the grid must be resizable.
*/
public boolean isResizable() {
return getGrid().isResizable();
}
/**
* Sets a flag value that means whether the grid columns will be resizable.
* This method also switches on / off table-layout style.
*
* @param resizable is a flag value.
*/
public void setResizable(boolean resizable) {
getGrid().setResizable(resizable);
}
/**
* Getter for property 'gridEventManager'.
*
* @return Value for property 'gridEventManager'.
*/
public GridEventManager getGridEventManager() {
if (gridEventManager == null)
gridEventManager = new DefaultGridEventManager(this);
return gridEventManager;
}
/**
* Setter for property 'gridEventManager'.
*
* @param gridEventManager Value to set for property 'gridEventManager'.
*/
public void setGridEventManager(GridEventManager gridEventManager) {
if (getGrid() != null) {
if (gridClickRegistration != null) {
gridClickRegistration.removeHandler();
gridClickRegistration = null;
}
if (gridFocusRegistration != null) {
gridFocusRegistration.removeHandler();
gridFocusRegistration = null;
}
if (gridBlurRegistration != null) {
gridBlurRegistration.removeHandler();
gridBlurRegistration = null;
}
}
this.gridEventManager = gridEventManager;
if (getGrid() != null && gridEventManager != null) {
gridClickRegistration = getGrid().addClickHandler(
getGridEventManager());
gridFocusRegistration = getFocusPanel().addFocusHandler(getGridEventManager());
gridBlurRegistration = getFocusPanel().addBlurHandler(getGridEventManager());
}
}
/** This method resizes nested components to make them fix as much space as possible. */
public void resize() {
boolean visible = isVisible();
setVisible(false);
adjust();
setVisible(visible);
adjust();
}
/**
* This method adds a new listener that is invoked on row selection.
*
* @param listener is a listener to be invoked.
*/
public void addSelectRowListener(SelectRowListener listener) {
if (getGrid() != null)
getGrid().addSelectRowListener(listener);
}
/**
* This method removes the specified row selection listener.
*
* @param listener is a listener to remove.
*/
public void removeSelectRowListener(SelectRowListener listener) {
if (getGrid() != null)
getGrid().removeSelectRowListener(listener);
}
/**
* Enables or disables the multi-row selection mode.
*
* @param enabled true means that this grid will allow multiple row selection.
*/
public void setMultiRowModeEnabled(boolean enabled) {
if (getGrid() != null)
getGrid().setMultiRowModeEnabled(enabled);
}
/**
* This method adds a new grid listener to be invoked on grid events.
*
* @param listener is a listener to add.
*/
public void addGridListener(GridListener listener) {
getMediator().addGridListener(listener);
}
/**
* This method removes the specified grid listener.
*
* @param listener is a listener to remove.
*/
public void removeGridListener(GridListener listener) {
getMediator().removeGridListener(listener);
}
/**
* Makes the widget take as much space as possible inside a parent element and resizes
* the nested grid.
*/
protected void adjust() {
Element parent = DOM.getParent(getElement());
if (parent != null)
GWTUtil.adjustWidgetSize(this, parent, false);
getGrid().resize();
}
/**
* Getter for property 'resizeHandler'.
*
* @return Value for property 'resizeHandler'.
*/
protected ResizeHandler getResizeHandler() {
if (resizeHandler == null)
resizeHandler = new WindowResizeHandler();
return resizeHandler;
}
/** This method displays a top panel and adds top pager and toolbar into it. */
protected void packTopPanel() {
if (isTopPagerVisible() || isTopToolbarVisible()) {
Panel panel = getTopPanel();
add(panel);
if (isTopPagerVisible())
preparePager(getTopPager(), panel).display();
if (isTopToolbarVisible())
prepareToolbar(getTopToolbar(), panel).display();
}
}
/** This method adds a grid into the panel. */
protected void packGrid() {
EditableGrid grid = getGrid();
FocusPanel focusPanel = getFocusPanel();
focusPanel.setWidget(grid);
add(focusPanel);
}
/** This method displays a bottom panel and adds a bottom pager and toolbar into it. */
protected void packBottomPanel() {
if (isBottomPagerVisible() || isBottomToolbarVisible()) {
Panel panel = getBottomPanel();
add(panel);
if (isBottomPagerVisible())
preparePager(getBottomPager(), panel).display();
if (isBottomToolbarVisible())
prepareToolbar(getBottomToolbar(), panel).display();
}
}
/**
* This method initializes a toolbar with common values.
*
* @param toolbar is a toolbar to be initialized.
* @param panel is a top or bottom panel.
* @return an initialized toolbar.
*/
protected GridToolbar prepareToolbar(GridToolbar toolbar, Panel panel) {
toolbar.setGridPanel(this);
panel.add(toolbar);
return toolbar;
}
/**
* This method initializes a pager with common values.
*
* @param pager is a pager to be initialized.
* @param panel is a top or bottom panel.
* @return an initialized toolbar.
*/
protected Pager preparePager(Pager pager, Panel panel) {
EditableGrid grid = getGrid();
Editable model = grid.getModel();
pager.setGridPanel(this);
pager.setModel(model);
pager.setArrowsVisible(isArrowsVisible());
panel.add(pager);
return pager;
}
/**
* Setter for property 'bottomPanel'.
*
* @param bottomPanel Value to set for property 'bottomPanel'.
*/
protected void setBottomPanel(Panel bottomPanel) {
this.bottomPanel = bottomPanel;
}
/**
* Setter for property 'topPanel'.
*
* @param topPanel Value to set for property 'topPanel'.
*/
protected void setTopPanel(Panel topPanel) {
this.topPanel = topPanel;
}
/**
* Setter for property 'topPager'.
*
* @param topPager Value to set for property 'topPager'.
*/
protected void setTopPager(Pager topPager) {
this.topPager = topPager;
}
/**
* Setter for property 'grid'.
*
* @param grid Value to set for property 'grid'.
*/
protected void setGrid(EditableGrid grid) {
this.grid = grid;
}
/**
* Setter for property 'topToolbar'.
*
* @param topToolbar Value to set for property 'topToolbar'.
*/
protected void setTopToolbar(GridToolbar topToolbar) {
this.topToolbar = topToolbar;
}
/**
* Setter for property 'bottomPager'.
*
* @param bottomPager Value to set for property 'bottomPager'.
*/
protected void setBottomPager(Pager bottomPager) {
this.bottomPager = bottomPager;
}
/**
* Setter for property 'bottomToolbar'.
*
* @param bottomToolbar Value to set for property 'bottomToolbar'.
*/
protected void setBottomToolbar(GridToolbar bottomToolbar) {
this.bottomToolbar = bottomToolbar;
}
/**
* Getter for property 'toolbarListeners'.
*
* @return Value for property 'toolbarListeners'.
*/
protected List getToolbarListeners() {
return toolbarListeners;
}
/**
* Getter for property 'pagerListeners'.
*
* @return Value for property 'pagerListeners'.
*/
protected List getPagerListeners() {
return pagerListeners;
}
/**
* This method adds a toolbar listener to the toolbars.
*
* @param gridToolbarListener is a toolbar listener.
*/
public void addToolbarListener(GridToolbarListener gridToolbarListener) {
getToolbarListeners().add(gridToolbarListener);
}
/**
* This method adds a new pager listener.
*
* @param pagerListener is a pager listener.
*/
public void addPagerListener(PagerListener pagerListener) {
getPagerListeners().add(pagerListener);
}
/**
* This method sets focus to the grid.
*
* @param focus is a focus flag value.
*/
public void setGridFocus(boolean focus) {
getFocusPanel().setFocus(focus);
}
/**
* Getter for property 'lockingPanel'.
*
* @return Value for property 'lockingPanel'.
*/
protected LockingPanel getLockingPanel() {
if (lockingPanel == null)
lockingPanel = new LockingPanel();
return lockingPanel;
}
/**
* Getter for property 'parentGridPanel'.
*
* @return Value for property 'parentGridPanel'.
*/
protected GridPanel getParentGridPanel() {
return parentGridPanel;
}
/**
* This method returns a list of child grid panels.
*
* @return a list of grid panels.
*/
public List getChildGridPanels() {
if (children == null)
children = new ArrayList();
return children;
}
/**
* Getter for property 'focusPanel'.
*
* @return Value for property 'focusPanel'.
*/
protected FocusPanel getFocusPanel() {
if (focusPanel == null) {
focusPanel = new FocusPanel();
focusPanel.setStyleName("advanced-FocusPanel");
}
return focusPanel;
}
/**
* This method adds a child grid panel.
*
* @param child is a child panel.
*/
protected void addChildGridPanel(GridPanel child) {
removeChildGridPanel(child);
getGrid().addSelectRowListener(getMediator());
getChildGridPanels().add(child);
}
/**
* This method removes a child grid panel.
*
* @param child a child grid panel.
*/
protected void removeChildGridPanel(GridPanel child) {
getGrid().removeSelectRowListener(getMediator());
getChildGridPanels().remove(child);
}
/**
* This handler is invoked every time when anything makes the window to be resized.
*
* @author Sergey Skladchikov
*/
protected class WindowResizeHandler implements ResizeHandler {
/**
* Resizes nested components.
*
* @param resizeEvent is a window resize event instance.
*/
public void onResize(ResizeEvent resizeEvent) {
resize();
}
}
}