ImageButton.java

/*!
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.gwt.widgets.client.buttons;

import com.google.gwt.event.dom.client.MouseDownEvent;
import com.google.gwt.event.dom.client.MouseDownHandler;
import com.google.gwt.event.dom.client.MouseOutEvent;
import com.google.gwt.event.dom.client.MouseOutHandler;
import com.google.gwt.event.dom.client.MouseOverEvent;
import com.google.gwt.event.dom.client.MouseOverHandler;
import com.google.gwt.event.dom.client.MouseUpEvent;
import com.google.gwt.event.dom.client.MouseUpHandler;
import com.google.gwt.user.client.DOM;
import com.google.gwt.user.client.Event;
import com.google.gwt.user.client.ui.Image;

/**
 * Clickable image with enable/disable functionality built in.
 * 
 * @deprecated use {@link ThemeableImageButton}
 */
@Deprecated
public class ImageButton extends Image {

  private boolean isEnabled = true;

  private String enabledUrl;

  private String disabledUrl;

  String imagePressedStyle = "image-button-pressed"; //$NON-NLS-1$

  String disabeldImagePressedStyle = "disabled-image-button-pressed"; //$NON-NLS-1$

  String imageHoverStyle = "image-button-over"; //$NON-NLS-1$

  String disabledImageHoverStyle = "disabled-image-button-over"; //$NON-NLS-1$

  String imageStyle = "image-button"; //$NON-NLS-1$

  String disabledImageStyle = "disabled-image-button"; //$NON-NLS-1$

  String themeImageDownStyle = "pentaho-imagebutton-down"; //$NON-NLS-1$

  String themeImageHoverStyle = "pentaho-imagebutton-hover"; //$NON-NLS-1$

  String themeDisabledImageStyle = "pentaho-imagebutton-disabled"; //$NON-NLS-1$

  public ImageButton( String enabledUrl, String disabledUrl, String tooltip ) {
    this( enabledUrl, disabledUrl, tooltip, 0, 0 );
  }

  public ImageButton() {
    super();
    setStyleName( imageStyle );

    this.addMouseDownHandler( new MouseDownHandler() {
      public void onMouseDown( MouseDownEvent event ) {
        removeStyleNames( imagePressedStyle, disabeldImagePressedStyle, themeImageDownStyle );

        if ( isEnabled ) {
          addStyleNames( imagePressedStyle, themeImageDownStyle );
        } else {
          addStyleNames( disabeldImagePressedStyle );
        }
      }
    } );
    this.addMouseUpHandler( new MouseUpHandler() {
      public void onMouseUp( MouseUpEvent event ) {
        removeStyleNames( imagePressedStyle, disabeldImagePressedStyle, themeImageDownStyle );
        updateStyles();
      }
    } );

    this.addMouseOverHandler( new MouseOverHandler() {
      public void onMouseOver( MouseOverEvent event ) {
        removeStyleNames( imageHoverStyle, disabledImageHoverStyle, themeImageHoverStyle );

        if ( isEnabled ) {
          addStyleNames( imageHoverStyle, themeImageHoverStyle );
        } else {
          addStyleName( disabledImageHoverStyle );
        }

      }
    } );

    this.addMouseOutHandler( new MouseOutHandler() {
      public void onMouseOut( MouseOutEvent event ) {
        removeStyleNames( imageHoverStyle, disabledImageHoverStyle, themeImageHoverStyle );
        updateStyles();
      }
    } );

  }

  private void updateStyles() {
    removeStyleNames( imageStyle, disabledImageStyle, themeDisabledImageStyle );

    if ( isEnabled ) {
      addStyleName( imageStyle );
    } else {
      addStyleNames( disabledImageStyle, themeDisabledImageStyle );
    }
  }

  public ImageButton( String enabledUrl, String disabledUrl, String tooltip, int width, int height ) {
    super( enabledUrl );

    setSize( width + "px", height + "px" ); //$NON-NLS-1$ //$NON-NLS-2$

    this.enabledUrl = enabledUrl;
    this.disabledUrl = disabledUrl;

    if ( tooltip != null && tooltip.length() > 0 ) {
      setTitle( tooltip );
    }

  }

  public void setEnabledUrl( String url ) {
    if ( this.enabledUrl != null && this.enabledUrl.equals( url ) ) {
      return;
    }

    this.enabledUrl = url;

    // only change the url if it's different and not null
    if ( isEnabled && this.getUrl().equals( enabledUrl ) == false ) {
      this.setSrc( enabledUrl );
    } else if ( !isEnabled && disabledUrl != null && this.getUrl().equals( disabledUrl ) == false ) {
      this.setSrc( disabledUrl );
    }
  }

  public void setDisabledUrl( String url ) {
    if ( this.disabledUrl != null && this.disabledUrl.equals( url ) ) {
      return;
    }
    this.disabledUrl = url;

    // only change the url if it's different and not null
    if ( isEnabled && enabledUrl != null && this.getUrl().equals( enabledUrl ) == false ) {
      this.setSrc( enabledUrl );
    } else if ( !isEnabled && this.getUrl().equals( disabledUrl ) == false ) {
      this.setSrc( disabledUrl );
    }
  }

  public void onBrowserEvent( Event event ) {
    super.onBrowserEvent( event );

    // This is required to prevent a drag & drop of the Image in the edit text.
    DOM.eventPreventDefault( event );
  }

  public boolean isEnabled() {
    return isEnabled;
  }

  public void setEnabled( boolean isEnabled ) {
    if ( this.isEnabled == isEnabled ) {
      return;
    }
    this.isEnabled = isEnabled;

    if ( isEnabled ) {
      this.setSrc( enabledUrl );
    } else if ( disabledUrl != null ) {
      this.setSrc( disabledUrl );
    }
    this.updateStyles();
  }

  /**
   * We're manipulating the DOM element directly instead of using the setUrl() method as setUrl(), which does a lot of
   * deferred loading / caching magic, was causing issues with IE.
   * 
   * @TODO Re-evaluate the need for this after the next GWT release.
   * @param src
   */
  private void setSrc( String src ) {
    this.getElement().setAttribute( "src", src ); //$NON-NLS-1$
  }

  public void setFocus( boolean focus ) {
    this.setFocus( focus );
  }

  public void removeStyleNames( String... names ) {
    for ( String name : names ) {
      removeStyleName( name );
    }
  }

  public void addStyleNames( String... names ) {
    for ( String name : names ) {
      addStyleName( name );
    }
  }

}