org.gwt.advanced.client.ui.widget

Class GridToolbar

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.FlowPanel

org.gwt.advanced.client.ui.widget.GridToolbar

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.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

public class GridToolbar
extends com.google.gwt.user.client.ui.FlowPanel
implements AdvancedWidget

This is a grid toolbar widget.

You can use it not only for the grid. Other widgets can implement the GridToolbarListener interface also.

Since:

1.0.0

Author:

Sergey Skladchikov

Nested Class Summary

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.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

Constructor Summary

Constructors

Constructor and Description
GridToolbar() Creates an instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	addButton(String image, com.google.gwt.event.dom.client.ClickHandler handler) This method adds an image button into the toolbar and doesn't specify hint text.
void	addButton(String image, String hint, com.google.gwt.event.dom.client.ClickHandler handler) This method adds an image button into the toolbar.
void	display() Use this method to displayActive the toolbar.
protected GridPanel	getGridPanel() Getter for property 'gridPanel'.
void	insertButton(int before, String image, com.google.gwt.event.dom.client.ClickHandler handler) Creates and inserts a new button into the specified position.
void	insertButton(int before, String image, String hint, com.google.gwt.event.dom.client.ClickHandler handler) Creates and inserts a new button into the specified position.
boolean	isAddButtonVisible() Getter for property 'addButtonVisible'.
boolean	isClearButtonVisible() Getter for property 'clearButtonVisible'.
boolean	isMoveLeftButtonVisible() Getter for property 'moveLeftButtonVisible'.
boolean	isMoveRightButtonVisible() Getter for property 'moveRightButtonVisible'.
boolean	isRemoveButtonVisible() Getter for property 'removeButtonVisible'.
boolean	isSaveButtonVisible() Getter for property 'saveButtonVisible'.
void	removeButton(int index) This method removes a button from the toolbar.
void	setAddButtonVisible(boolean addButtonVisible) Setter for property 'addButtonVisible'.
void	setButtonEnabled(int index, boolean enabled) Sets a button enabled or disabled.
void	setButtonVisible(int index, boolean visible) Sets a button visible or invisible.
void	setClearButtonVisible(boolean clearButtonVisible) Setter for property 'clearButtonVisible'.
protected void	setGridPanel(GridPanel gridPanel) Setter for property 'gridPanel'.
void	setMoveLeftButtonVisible(boolean moveLeftButtonVisible) Setter for property 'moveLeftButtonVisible'.
void	setMoveRightButtonVisible(boolean moveRightButtonVisible) Setter for property 'moveRightButtonVisible'.
void	setRemoveButtonVisible(boolean removeButtonVisible) Setter for property 'removeButtonVisible'.
void	setSaveButtonVisible(boolean saveButtonVisible) Setter for property 'saveButtonVisible'.

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

add, clear, insert, insert

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

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

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

add, adopt, adopt, 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, onEnsureDebugId, 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

GridToolbar

public GridToolbar()

Creates an instance of this class.

Method Detail

display

public void display()

Use this method to displayActive the toolbar.

Specified by:

display in interface AdvancedWidget

isAddButtonVisible

public boolean isAddButtonVisible()

Getter for property 'addButtonVisible'.

Returns:

Value for property 'addButtonVisible'.

setAddButtonVisible

public void setAddButtonVisible(boolean addButtonVisible)

Setter for property 'addButtonVisible'.

Parameters:

addButtonVisible - Value to set for property 'addButtonVisible'.

isRemoveButtonVisible

public boolean isRemoveButtonVisible()

Getter for property 'removeButtonVisible'.

Returns:

Value for property 'removeButtonVisible'.

setRemoveButtonVisible

public void setRemoveButtonVisible(boolean removeButtonVisible)

Setter for property 'removeButtonVisible'.

Parameters:

removeButtonVisible - Value to set for property 'removeButtonVisible'.

isSaveButtonVisible

public boolean isSaveButtonVisible()

Getter for property 'saveButtonVisible'.

Returns:

Value for property 'saveButtonVisible'.

setSaveButtonVisible

public void setSaveButtonVisible(boolean saveButtonVisible)

Setter for property 'saveButtonVisible'.

Parameters:

saveButtonVisible - Value to set for property 'saveButtonVisible'.

isClearButtonVisible

public boolean isClearButtonVisible()

Getter for property 'clearButtonVisible'.

Returns:

Value for property 'clearButtonVisible'.

setClearButtonVisible

public void setClearButtonVisible(boolean clearButtonVisible)

Setter for property 'clearButtonVisible'.

Parameters:

clearButtonVisible - Value to set for property 'clearButtonVisible'.

isMoveLeftButtonVisible

public boolean isMoveLeftButtonVisible()

Getter for property 'moveLeftButtonVisible'.

Returns:

Value for property 'moveLeftButtonVisible'.

setMoveLeftButtonVisible

public void setMoveLeftButtonVisible(boolean moveLeftButtonVisible)

Setter for property 'moveLeftButtonVisible'.

Parameters:

moveLeftButtonVisible - Value to set for property 'moveLeftButtonVisible'.

isMoveRightButtonVisible

public boolean isMoveRightButtonVisible()

Getter for property 'moveRightButtonVisible'.

Returns:

Value for property 'moveRightButtonVisible'.

setMoveRightButtonVisible

public void setMoveRightButtonVisible(boolean moveRightButtonVisible)

Setter for property 'moveRightButtonVisible'.

Parameters:

moveRightButtonVisible - Value to set for property 'moveRightButtonVisible'.

addButton

public void addButton(String image,
             com.google.gwt.event.dom.client.ClickHandler handler)

This method adds an image button into the toolbar and doesn't specify hint text.

Parameters:

image - is an image of the button.

handler - is a handler to be invoked on button click.

addButton

public void addButton(String image,
             String hint,
             com.google.gwt.event.dom.client.ClickHandler handler)

This method adds an image button into the toolbar.

Parameters:

image - is an image of the button.

hint - is a popup hint of the button.

handler - is a handler to be invoked on button click.

removeButton

public void removeButton(int index)

This method removes a button from the toolbar.

It also removes a click handler associated with the button.

Parameters:

index - is an index of the button.

insertButton

public void insertButton(int before,
                String image,
                com.google.gwt.event.dom.client.ClickHandler handler)

Creates and inserts a new button into the specified position.

Parameters:

before - is a position of the new button.

image - is an image URL.

handler - is a handler for this button to be invoked on click.

insertButton

public void insertButton(int before,
                String image,
                String hint,
                com.google.gwt.event.dom.client.ClickHandler handler)

Creates and inserts a new button into the specified position.

Parameters:

before - is a position of the new button.

image - is an image URL.

hint - is a button hint value.

handler - is a handler for this button to be invoked on click.

setButtonVisible

public void setButtonVisible(int index,
                    boolean visible)

Sets a button visible or invisible.

Parameters:

index - is an index of the button in the toolbar.

visible - is a visibility option.

setButtonEnabled

public void setButtonEnabled(int index,
                    boolean enabled)

Sets a button enabled or disabled.

Parameters:

index - is an index of the button in the toolbar.

enabled - is a button enabled option.

getGridPanel

protected GridPanel getGridPanel()

Getter for property 'gridPanel'.

Returns:

Value for property 'gridPanel'.

setGridPanel

protected void setGridPanel(GridPanel gridPanel)

Setter for property 'gridPanel'.

Parameters:

gridPanel - Value to set for property 'gridPanel'.