SpoonBrowser.java

/*! ******************************************************************************
 *
 * Pentaho Data Integration
 *
 * Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
 *
 *******************************************************************************
 *
 * 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.pentaho.di.ui.spoon;

import java.util.ResourceBundle;

import org.eclipse.swt.SWT;
import org.eclipse.swt.SWTError;
import org.eclipse.swt.browser.Browser;
import org.eclipse.swt.browser.LocationEvent;
import org.eclipse.swt.browser.LocationListener;
import org.eclipse.swt.layout.FormAttachment;
import org.eclipse.swt.layout.FormData;
import org.eclipse.swt.layout.FormLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.swt.widgets.ToolBar;
import org.pentaho.di.core.EngineMetaInterface;
import org.pentaho.di.core.Props;
import org.pentaho.di.i18n.BaseMessages;
import org.pentaho.di.i18n.GlobalMessages;
import org.pentaho.di.ui.core.dialog.ErrorDialog;
import org.pentaho.di.ui.xul.KettleXulLoader;
import org.pentaho.ui.xul.XulDomContainer;
import org.pentaho.ui.xul.XulLoader;
import org.pentaho.ui.xul.components.XulTextbox;
import org.pentaho.ui.xul.components.XulToolbarbutton;
import org.pentaho.ui.xul.containers.XulToolbar;
import org.pentaho.ui.xul.impl.XulEventHandler;

/**
 * This class handles the display of help information like the welcome page and JDBC info in an embedded browser.
 *
 * @author Matt
 * @since November 2006
 *
 */

public class SpoonBrowser implements TabItemInterface, XulEventHandler {

  private static final Class<?> PKG = SpoonBrowser.class;

  private static final String XUL_FILE_BROWSER_TOOLBAR = "ui/browser-toolbar.xul";

  protected Shell shell;

  protected Spoon spoon;

  private String stringUrl;

  protected Composite composite;

  protected XulToolbar toolbar;

  protected Browser browser;

  private XulToolbarbutton back = null;

  private XulToolbarbutton forward = null;

  private XulTextbox location;

  public SpoonBrowser( Composite parent, final Spoon spoon, final String stringUrl, boolean isURL ) throws SWTError {
    this( parent, spoon, stringUrl, isURL, true, null );
  }

  public SpoonBrowser( Composite parent, final Spoon spoon, final String stringUrl, boolean isURL,
    LocationListener listener ) throws SWTError {
    this( parent, spoon, stringUrl, isURL, true, listener );
  }

  public SpoonBrowser( Composite parent, final Spoon spoon, final String stringUrl, boolean isURL,
    boolean showControls, LocationListener listener ) throws SWTError {
    composite = new Composite( parent, SWT.NONE );

    this.shell = parent.getShell();
    this.spoon = spoon;
    this.stringUrl = stringUrl;

    composite.setLayout( new FormLayout() );

    if ( showControls ) {
      addToolBar();

      // HACK ALERT : setting this in some sort of property would be far nicer
      //
      // TODO figure out what this was supposed to do.
      Control swtToolBar = (Control) toolbar.getManagedObject();
      FormData fdToolBar = (FormData) swtToolBar.getLayoutData();
      fdToolBar.left = new FormAttachment( 0, 0 );
      fdToolBar.right = new FormAttachment( 100, 0 );
      fdToolBar.top = new FormAttachment( 0, 0 );

    }

    browser = createBrowser();
    FormData fdBrowser = new FormData();
    fdBrowser.left = new FormAttachment( 0, 0 );
    fdBrowser.right = new FormAttachment( 100, 0 );
    if ( showControls ) {
      fdBrowser.top = new FormAttachment( (Control) toolbar.getManagedObject(), 2 );
    } else {
      fdBrowser.top = new FormAttachment( 0, 2 );
    }
    fdBrowser.bottom = new FormAttachment( 100, 0 );
    browser.setLayoutData( fdBrowser );

    LocationListener locationListener = new LocationListener() {
      public void changed( LocationEvent event ) {
        Browser browser = (Browser) event.widget;
        if ( back != null ) {
          back.setDisabled( !browser.isBackEnabled() );
          forward.setDisabled( !browser.isForwardEnabled() );
          location.setValue( browser.getUrl() );
        }
      }

      public void changing( LocationEvent event ) {
      }
    };

    browser.addLocationListener( locationListener );

    if ( listener != null ) {
      browser.addLocationListener( listener );
    }

    // Set the text
    if ( isURL ) {
      browser.setUrl( stringUrl );
    } else {
      browser.setText( stringUrl );
    }
  }

  protected Browser createBrowser() {
    return new Browser( composite, SWT.NONE );
  }

  public void addLocationListener( LocationListener listener ) {
    browser.addLocationListener( listener );
  }

  protected void addToolBar() {

    try {
      XulLoader loader = new KettleXulLoader();
      loader.setSettingsManager( XulSpoonSettingsManager.getInstance() );
      ResourceBundle bundle = GlobalMessages.getBundle( "org/pentaho/di/ui/spoon/messages/messages" );
      XulDomContainer xulDomContainer = loader.loadXul( XUL_FILE_BROWSER_TOOLBAR, bundle );
      xulDomContainer.addEventHandler( this );
      toolbar = (XulToolbar) xulDomContainer.getDocumentRoot().getElementById( "nav-toolbar" );

      @SuppressWarnings( "unused" )
      ToolBar swtToolBar = (ToolBar) toolbar.getManagedObject();
      spoon.props.setLook( swtToolBar, Props.WIDGET_STYLE_TOOLBAR );

      // Add a URL

      back = (XulToolbarbutton) toolbar.getElementById( "browse-back" );
      back.setDisabled( true );
      forward = (XulToolbarbutton) toolbar.getElementById( "browse-forward" );
      forward.setLabel( BaseMessages.getString( PKG, "SpoonBrowser.Dialog.Forward" ) );
      forward.setDisabled( false );
      location = (XulTextbox) toolbar.getElementById( "browser-address" );
      Control toolbarControl = (Control) toolbar.getManagedObject();
      toolbarControl.setLayoutData( new FormData() );
      toolbarControl.setParent( composite );
    } catch ( Exception e ) {
      e.printStackTrace();
      new ErrorDialog(
        shell, BaseMessages.getString( PKG, "Spoon.Exception.ErrorReadingXULFile.Title" ), BaseMessages
          .getString( PKG, "Spoon.Exception.ErrorReadingXULFile.Message", XUL_FILE_BROWSER_TOOLBAR ), e );
    }
  }

  public void openFile() {
    spoon.openFile();
  }

  public void browseBack() {
    browser.back();
  }

  public void browseForward() {
    browser.forward();
  }

  /**
   * @return the browser
   */
  public Browser getBrowser() {
    return browser;
  }

  /**
   * @return the shell
   */
  public Shell getShell() {
    return shell;
  }

  /**
   * @return the spoon
   */
  public Spoon getSpoon() {
    return spoon;
  }

  /**
   * @param spoon
   *          the spoon to set
   */
  public void setSpoon( Spoon spoon ) {
    this.spoon = spoon;
  }

  public boolean applyChanges() {
    return true;
  }

  public boolean canBeClosed() {
    return true;
  }

  public Object getManagedObject() {
    return stringUrl;
  }

  public boolean hasContentChanged() {
    return false;
  }

  public int showChangedWarning() {
    return 0;
  }

  /**
   * @return the composite
   */
  public Composite getComposite() {
    return composite;
  }

  /**
   * @param composite
   *          the composite to set
   */
  public void setComposite( Composite composite ) {
    this.composite = composite;
  }

  public EngineMetaInterface getMeta() {
    return null;
  }

  public boolean canHandleSave() {
    return false;
  }

  public boolean setFocus() {
    // TODO Auto-generated method stub
    return false;
  }

  /*
   * (non-Javadoc)
   *
   * @see org.pentaho.ui.xul.impl.XulEventHandler#getData()
   */
  public Object getData() {
    // TODO Auto-generated method stub
    return null;
  }

  /*
   * (non-Javadoc)
   *
   * @see org.pentaho.ui.xul.impl.XulEventHandler#getName()
   */
  public String getName() {
    return "browser";
  }

  /*
   * (non-Javadoc)
   *
   * @see org.pentaho.ui.xul.impl.XulEventHandler#getXulDomContainer()
   */
  public XulDomContainer getXulDomContainer() {
    // TODO Auto-generated method stub
    return null;
  }

  /*
   * (non-Javadoc)
   *
   * @see org.pentaho.ui.xul.impl.XulEventHandler#setData(java.lang.Object)
   */
  public void setData( Object data ) {
    // TODO Auto-generated method stub

  }

  /*
   * (non-Javadoc)
   *
   * @see org.pentaho.ui.xul.impl.XulEventHandler#setName(java.lang.String)
   */
  public void setName( String name ) {
    // TODO Auto-generated method stub

  }

  /*
   * (non-Javadoc)
   *
   * @see org.pentaho.ui.xul.impl.XulEventHandler#setXulDomContainer(org.pentaho.ui.xul.XulDomContainer)
   */
  public void setXulDomContainer( XulDomContainer xulDomContainer ) {
    // TODO Auto-generated method stub

  }

  public void setControlStates() {

  }

  public ChangedWarningInterface getChangedWarning() {
    return null;
  }
}