com.maryanovsky.gwtutils.client
Class ImageButton

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.maryanovsky.gwtutils.client.ImageButton

All Implemented Interfaces:

EventListener, SourcesClickEvents

Direct Known Subclasses:

ToggleImageButton

public class ImageButton
extends Composite
implements SourcesClickEvents

An button widget with an image (with rollover and selection effects) and an optional label. The primary style name of this widget is "gwtutils-ImageButton". The dependent style names of the widget are "rollover", "selected" and "disabled". The primary style name of the image is "gwtutils-ImageButtonImage" and the primary style name of the label is "gwtutils-ImageButtonLabel".

Author:

Maryanovsky Alexander

Nested Class Summary

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

ImageButton(AbstractImagePrototype image)
Creates an ImageButton with the specified image prototype, which will be used for all button states (normal, rollover, selected, disabled).

ImageButton(AbstractImagePrototype normal, AbstractImagePrototype rollover, AbstractImagePrototype selected, AbstractImagePrototype disabled)
Creates an ImageButton with images retrieved from the specified image prototypes.

ImageButton(String image)
Creates an ImageButton with the specified image URL, which will be used for all button states (normal, rollover, selected, disabled).

ImageButton(String normal, String rollover, String selected, String disabled)
Creates an ImageButton with images retrieved from the specified URLs.

Method Summary

void	addClickListener(ClickListener listener)
String	getText() Returns the text of the button.
protected void	handleBrowserEvent(Event evt) Invoked when an event occurs on this ImageButton.
boolean	isEnabled() Returns the enabled state of the button.
void	removeClickListener(ClickListener listener)
void	setEnabled(boolean isEnabled) Sets the enabled state of the button.
void	setText(String text) Sets the text of the button.

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

getWidget, initWidget, isAttached, onAttach, onBrowserEvent, onDetach, setWidget

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

doAttachChildren, doDetachChildren, getParent, onLoad, onUnload, removeFromParent

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, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageButton

public ImageButton(String image)

Creates an ImageButton with the specified image URL, which will be used for all button states (normal, rollover, selected, disabled).

ImageButton

public ImageButton(AbstractImagePrototype image)

Creates an ImageButton with the specified image prototype, which will be used for all button states (normal, rollover, selected, disabled).

ImageButton

public ImageButton(String normal,
                   String rollover,
                   String selected,
                   String disabled)

Creates an ImageButton with images retrieved from the specified URLs.

Parameters:

normal - The location of the normal image.

rollover - The location of the image to display when the mouse is over the widget. If null, defaults to the normal image.

selected - The location of the image to display when the button is pressed. If null, defaults to the rollover image.

disabled - The location of the image to display when disabled. If null, defaults to the normal image.

ImageButton

public ImageButton(AbstractImagePrototype normal,
                   AbstractImagePrototype rollover,
                   AbstractImagePrototype selected,
                   AbstractImagePrototype disabled)

Creates an ImageButton with images retrieved from the specified image prototypes.

Parameters:

normal - The prototype of the normal image.

rollover - The prototype of the image to display when the mouse is over the widget. If null, defaults to the normal image.

selected - The prototype of the image to display when the button is pressed. If null, defaults to the rollover image.

disabled - The prototype of the image to display when disabled. If null, defaults to the normal image.

Method Detail

setText

public void setText(String text)

Sets the text of the button.

getText

public String getText()

Returns the text of the button.

setEnabled

public void setEnabled(boolean isEnabled)

Sets the enabled state of the button.

isEnabled

public boolean isEnabled()

Returns the enabled state of the button.

addClickListener

public void addClickListener(ClickListener listener)

Specified by:

addClickListener in interface SourcesClickEvents

removeClickListener

public void removeClickListener(ClickListener listener)

Specified by:

removeClickListener in interface SourcesClickEvents

handleBrowserEvent

protected void handleBrowserEvent(Event evt)

Invoked when an event occurs on this ImageButton.