org.gwt.advanced.client.ui.widget.GridToolbar 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.core.client.GWT;
import com.google.gwt.event.dom.client.ClickEvent;
import com.google.gwt.event.dom.client.ClickHandler;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.user.client.ui.FlowPanel;
import com.google.gwt.user.client.ui.FocusWidget;
import com.google.gwt.user.client.ui.ToggleButton;
import com.google.gwt.user.client.ui.Widget;
import org.gwt.advanced.client.ui.AdvancedWidget;
import org.gwt.advanced.client.ui.resources.GridToolbarConstants;
import org.gwt.advanced.client.ui.widget.theme.ThemeImage;
import java.util.ArrayList;
import java.util.List;
/**
* This is a grid toolbar widget.
* You can use it not only for the grid. Other widgets can implement the
* {@link org.gwt.advanced.client.ui.GridToolbarListener} interface also.
*
* @author Sergey Skladchikov
* @since 1.0.0
*/
public class GridToolbar extends FlowPanel implements AdvancedWidget {
/** toolbar resource bundle */
private static final GridToolbarConstants RESOURCE = (GridToolbarConstants) GWT.create(GridToolbarConstants.class);
/** a flag meaning whether the Add button should be displayed */
private boolean addButtonVisible = true;
/** a flag meaning whether the Remove button should be displayed */
private boolean removeButtonVisible = true;
/** a flag meaning whether the Save button should be displayed */
private boolean saveButtonVisible = true;
/** a flag meaning whether the Clear button should be displayed */
private boolean clearButtonVisible = true;
/** a flag meaning whether the move left button should be displayed */
private boolean moveLeftButtonVisible = true;
/** a flag meaning whether the move right button should be displayed */
private boolean moveRightButtonVisible = true;
/** a grid panel instance */
private GridPanel gridPanel;
/** click handler registrations for the buttons */
private List registrations = new ArrayList();
/**
* Creates an instance of this class.
*/
public GridToolbar () {
}
/**
* Use this method to displayActive the toolbar.
*/
public void display() {
setStyleName("advanced-GridToolbar");
while(getWidgetCount() > 0)
remove(getWidgetCount() - 1);
if (isAddButtonVisible()) {
addButton(
"new.gif", RESOURCE.getAddNew(),
new ClickHandler(){
public void onClick(ClickEvent clickEvent) {
getGridPanel().getMediator().fireAddRowEvent();
((ToggleButton)clickEvent.getSource()).setDown(false);
}
}
);
}
if (isSaveButtonVisible()) {
addButton(
"save.gif", RESOURCE.getSaveChanges(),
new ClickHandler(){
public void onClick(ClickEvent clickEvent) {
getGridPanel().getMediator().fireSaveEvent();
((ToggleButton)clickEvent.getSource()).setDown(false);
}
}
);
}
if (isRemoveButtonVisible()) {
addButton(
"delete.gif", RESOURCE.getRemoveRow(),
new ClickHandler(){
public void onClick(ClickEvent clickEvent) {
getGridPanel().getMediator().fireRemoveRowEvent();
((ToggleButton)clickEvent.getSource()).setDown(false);
}
}
);
}
if (isClearButtonVisible()) {
addButton(
"delete-all.gif", RESOURCE.getRemoveAll(),
new ClickHandler(){
public void onClick(ClickEvent clickEvent) {
getGridPanel().getMediator().fireClearEvent();
((ToggleButton)clickEvent.getSource()).setDown(false);
}
}
);
}
if (isMoveLeftButtonVisible()) {
addButton(
"level-up.gif", RESOURCE.getLevelUp(),
new ClickHandler(){
public void onClick(ClickEvent clickEvent) {
getGridPanel().getMediator().fireMoveLeftEvent();
((ToggleButton)clickEvent.getSource()).setDown(false);
}
}
);
}
if (isMoveRightButtonVisible()) {
addButton(
"level-down.gif", RESOURCE.getLevelDown(),
new ClickHandler(){
public void onClick(ClickEvent clickEvent) {
getGridPanel().getMediator().fireMoveRightEvent();
}
}
);
}
}
/**
* Getter for property 'addButtonVisible'.
*
* @return Value for property 'addButtonVisible'.
*/
public boolean isAddButtonVisible() {
return addButtonVisible;
}
/**
* Setter for property 'addButtonVisible'.
*
* @param addButtonVisible Value to set for property 'addButtonVisible'.
*/
public void setAddButtonVisible(boolean addButtonVisible) {
this.addButtonVisible = addButtonVisible;
}
/**
* Getter for property 'removeButtonVisible'.
*
* @return Value for property 'removeButtonVisible'.
*/
public boolean isRemoveButtonVisible() {
return removeButtonVisible;
}
/**
* Setter for property 'removeButtonVisible'.
*
* @param removeButtonVisible Value to set for property 'removeButtonVisible'.
*/
public void setRemoveButtonVisible(boolean removeButtonVisible) {
this.removeButtonVisible = removeButtonVisible;
}
/**
* Getter for property 'saveButtonVisible'.
*
* @return Value for property 'saveButtonVisible'.
*/
public boolean isSaveButtonVisible() {
return saveButtonVisible;
}
/**
* Setter for property 'saveButtonVisible'.
*
* @param saveButtonVisible Value to set for property 'saveButtonVisible'.
*/
public void setSaveButtonVisible(boolean saveButtonVisible) {
this.saveButtonVisible = saveButtonVisible;
}
/**
* Getter for property 'clearButtonVisible'.
*
* @return Value for property 'clearButtonVisible'.
*/
public boolean isClearButtonVisible() {
return clearButtonVisible;
}
/**
* Setter for property 'clearButtonVisible'.
*
* @param clearButtonVisible Value to set for property 'clearButtonVisible'.
*/
public void setClearButtonVisible(boolean clearButtonVisible) {
this.clearButtonVisible = clearButtonVisible;
}
/**
* Getter for property 'moveLeftButtonVisible'.
*
* @return Value for property 'moveLeftButtonVisible'.
*/
public boolean isMoveLeftButtonVisible() {
return moveLeftButtonVisible && getGridPanel().getGrid() instanceof TreeGrid;
}
/**
* Setter for property 'moveLeftButtonVisible'.
*
* @param moveLeftButtonVisible Value to set for property 'moveLeftButtonVisible'.
*/
public void setMoveLeftButtonVisible(boolean moveLeftButtonVisible) {
this.moveLeftButtonVisible = moveLeftButtonVisible;
}
/**
* Getter for property 'moveRightButtonVisible'.
*
* @return Value for property 'moveRightButtonVisible'.
*/
public boolean isMoveRightButtonVisible() {
return moveRightButtonVisible && getGridPanel().getGrid() instanceof TreeGrid;
}
/**
* Setter for property 'moveRightButtonVisible'.
*
* @param moveRightButtonVisible Value to set for property 'moveRightButtonVisible'.
*/
public void setMoveRightButtonVisible(boolean moveRightButtonVisible) {
this.moveRightButtonVisible = moveRightButtonVisible;
}
/**
* This method adds an image button into the toolbar and doesn't specify hint text.
*
* @param image is an image of the button.
* @param handler is a handler to be invoked on button click.
*/
public void addButton(String image, ClickHandler handler) {
addButton(image, null, handler);
}
/**
* This method adds an image button into the toolbar.
*
* @param image is an image of the button.
* @param hint is a popup hint of the button.
* @param handler is a handler to be invoked on button click.
*/
public void addButton(String image, String hint, ClickHandler handler) {
ToggleButton button = new ToggleButton(new ThemeImage(image));
button.setStyleName("advanced-GridToolbar-button");
registrations.add(button.addClickHandler(handler));
button.setTitle(hint);
add(button);
}
/**
* This method removes a button from the toolbar.
* It also removes a click handler associated with the button.
*
* @param index is an index of the button.
*/
public void removeButton(int index) {
remove(index);
HandlerRegistration registration = registrations.get(index);
registration.removeHandler();
registrations.remove(index);
}
/**
* Creates and inserts a new button into the specified position.
*
* @param before is a position of the new button.
* @param image is an image URL.
* @param handler is a handler for this button to be invoked on click.
*/
public void insertButton(int before, String image, ClickHandler handler) {
insertButton(before, image, null, handler);
}
/**
* Creates and inserts a new button into the specified position.
*
* @param before is a position of the new button.
* @param image is an image URL.
* @param hint is a button hint value.
* @param handler is a handler for this button to be invoked on click.
*/
public void insertButton(int before, String image, String hint, ClickHandler handler) {
ToggleButton button = new ToggleButton(new ThemeImage(image));
button.setStyleName("advanced-GridToolbar-button");
registrations.add(before, button.addClickHandler(handler));
button.setTitle(hint);
insert(button, before);
}
/**
* Sets a button visible or invisible.
*
* @param index is an index of the button in the toolbar.
* @param visible is a visibility option.
*/
public void setButtonVisible(int index, boolean visible) {
getWidget(index).setVisible(visible);
}
/**
* Sets a button enabled or disabled.
*
* @param index is an index of the button in the toolbar.
* @param enabled is a button enabled option.
*/
public void setButtonEnabled(int index, boolean enabled) {
Widget widget = getWidget(index);
if (widget instanceof FocusWidget)
((FocusWidget) widget).setEnabled(enabled);
}
/**
* Getter for property 'gridPanel'.
*
* @return Value for property 'gridPanel'.
*/
protected GridPanel getGridPanel () {
if (gridPanel == null)
gridPanel = new GridPanel();
return gridPanel;
}
/**
* Setter for property 'gridPanel'.
*
* @param gridPanel Value to set for property 'gridPanel'.
*/
protected void setGridPanel (GridPanel gridPanel) {
this.gridPanel = gridPanel;
}
}