com.maryanovsky.gwtutils.client
Class ToggleImageButton

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

All Implemented Interfaces:

EventListener, SourcesClickEvents

public class ToggleImageButton
extends ImageButton

A toggle button based on the ImageButton class. The primary style name for this widget is "gwtutils-ToggleImageButton". Toggled buttons have a dependent style name of "toggled".

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

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

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

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

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

Method Summary

protected void	handleBrowserEvent(Event evt) Invoked when an event occurs on this ImageButton.
boolean	isToggled() Returns whether this button is currently toggled.
void	setToggled(boolean isToggled) Sets this button's toggled state.

Methods inherited from class com.maryanovsky.gwtutils.client.ImageButton

addClickListener, getText, isEnabled, removeClickListener, setEnabled, setText

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

ToggleImageButton

public ToggleImageButton(String image)

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

ToggleImageButton

public ToggleImageButton(AbstractImagePrototype image)

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

ToggleImageButton

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

Creates a ToggleImageButton 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.

ToggleImageButton

public ToggleImageButton(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

setToggled

public void setToggled(boolean isToggled)

Sets this button's toggled state.

isToggled

public boolean isToggled()

Returns whether this button is currently toggled.

handleBrowserEvent

protected void handleBrowserEvent(Event evt)

Invoked when an event occurs on this ImageButton.

Overrides:

handleBrowserEvent in class ImageButton