Package org.jmule.ui.swt.tables

Source Code of org.jmule.ui.swt.tables.BufferedTableRow

/*
*  JMule - Java file sharing client
*  Copyright (C) 2007-2008 JMule team ( jmule@jmule.org / http://jmule.org )
*
*  Any parts of this program derived from other projects, or contributed
*  by third-party developers are copyrighted by their respective authors.
*
*  This program is free software; you can redistribute it and/or
*  modify it under the terms of the GNU General Public License
*  as published by the Free Software Foundation; either version 2
*  of the License, or (at your option) any later version.
*
*  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 General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with this program; if not, write to the Free Software
*  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*
*/
package org.jmule.ui.swt.tables;

import java.util.Hashtable;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Color;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Table;
import org.eclipse.swt.widgets.TableItem;
import org.jmule.ui.swt.Utils;
/**
* A buffered Table Row.
*<p>
* We buffer certain properties of TableRow to save CPU cycles.  For example,
* foreground_colors is cached because TableItem.getForegroundColor is expensive
* when there is no color set, and setForegroundColor is always expensive.
*<p>
* Text is not buffered as SWT does a good job of buffering it already.
*<p>
*
* @note For Virtual tables, we can not set any visual properties until
*        SWT.SetData has been called.  getData("SD") is set after SetData
*        call, and the row is invalidated.  Thus, there is no need to set
*        any visual properties until the row #isVisible()
*
* @author parg<br>
* @author TuxPaper (SWT.Virtual Stuff)
* @author binary256
* @version $$Revision: 1.3 $$
* Last changed by $$Author: binary255 $$ on $$Date: 2009/12/04 16:07:21 $$
*/
public class BufferedTableRow {
 
  private List<BufferedTableRowCustomControl> custom_control_list = new LinkedList<BufferedTableRowCustomControl>();
 
  public List<BufferedTableRowCustomControl> getControlList() {
    return custom_control_list;
  }
 
  private static final int VALUE_SIZE_INC  = 8;
 
  private static Color[] alternatingColors = null;

  // for checkWidget(int)
  public final static int REQUIRE_TABLEITEM = 0;
  public final static int REQUIRE_TABLEITEM_INITIALIZED = 1;
  public final static int REQUIRE_VISIBILITY = 2;
 
  protected Table table;
  protected TableItem  item;
 
  protected Image[]  image_values  = new Image[0];
  protected Color[]  foreground_colors  = new Color[0];
 
  protected Color    foreground;
 
  // remove when things work
  private static final boolean bDebug = false;
 
  private Point ptIconSize = null;
 
  /**
   * Default constructor
   *
   * @param _table
   */
  public BufferedTableRow(Table _table)
  {
    table = _table;
    item = null;   
  }
 
  public TableItem getTableItem() {
    return item;
  }
 
  /**
   * Create a row in the SWT table
   *
   */
  public void createSWTRow() {
    item = new TableItem(table, SWT.NULL);
    //setAlternatingBGColor(false);
  }
 
  public void setSWTRow(TableItem item) {
    this.item = item;
    //setAlternatingBGColor(false);
  }

  public void createSWTRow(int index) {
    new TableItem(table, SWT.NULL);
    setTableItem(index, false);
  }
 
  public void setAlternatingBGColor(boolean bEvenIfNotVisible) {
//    if (Utils.TABLE_GRIDLINE_IS_ALTERNATING_COLOR)
//      return;
     
  //  if ((table.getStyle() & SWT.VIRTUAL) != 0 && !bEvenIfNotVisible
  //      && !isVisible()) {
  //    return;
  //  } else if (item == null || item.isDisposed()) {
  //    return;
  //  }

    int index = table.indexOf(item);
    if (index == -1) {
      return;
    }

    if (alternatingColors == null || alternatingColors[1].isDisposed()) {
      alternatingColors = new Color[] {
          table.getDisplay().getSystemColor(SWT.COLOR_WHITE),
          table.getDisplay().getSystemColor(SWT.COLOR_WHITE)  };
    }

    Color newColor = alternatingColors[index % alternatingColors.length];
    if (!newColor.equals(getBackground()))
      item.setBackground(newColor);
  }

  public void setBackgrounColor(Color color) {
    item.setBackground(color);
  }
 
  /**
   * Disposes of underlying SWT TableItem. If no TableItem has been
   * assigned to the row yet, an unused TableItem will be disposed of, if
   * available.
   * <p>
   * Disposing of fonts, colors and other resources are the responsibilty of
   * the caller.
   */
  public void
  dispose()
  {
    if (table != null && !table.isDisposed() ) {
      if (!checkWidget(REQUIRE_TABLEITEM)) {
        // No assigned spot yet, or not our spot:
        // find a row with no TableRow data

        TableItem[] items = table.getItems();
        for (int i = items.length - 1; i >= 0; i--) {
          TableItem item = items[i];
          if (!item.isDisposed()) {
            Object itemRow = item.getData("TableRow");
            if (itemRow == null || itemRow == this) {
              this.item = item;
              break;
            }
          }
        }
      }
     
      if (item != null && !item.isDisposed())
        item.dispose();
      else if (table.getItemCount() > 0)
        System.err.println("No table row was found to dispose");
    } else {
     
    }
    item = null;
    for(Image image : image_values)
      if (image != null)
        image.dispose();
  }
 
  public Image getImage(int id) {
    if (id >= image_values.length) return null;
    return image_values[id];
  }
 
  /**
   * Sets the receiver's image at a column.
   *
   * @param index the column index
   * @param new_image the new image
   */
  public void
  setImage(
       int   index,
    Image  new_image )
  {
  //  if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
  //    return;

    if ( index >= image_values.length ){
     
      int  new_size = Math.max( index+1, image_values.length+VALUE_SIZE_INC );
     
      Image[]  new_images = new Image[new_size];
     
      System.arraycopy( image_values, 0, new_images, 0, image_values.length );
     
      image_values = new_images;
    }
   
    Image  image = image_values[index];
   
    if ( new_image == image ){
     
      return;
    }
   
    image_values[index] = new_image;
   
    item.setImage( index, new_image )
  }

  /**
   * Checks if the widget is valid
   *
   * @param checkFlags REQUIRE_* flags (OR'd)
   *
   * @return True: Ok; False: Not ok
   */
  public boolean checkWidget(int checkFlags) {
  //  boolean bWidgetOk = !table.isDisposed() && item != null
  //      && !item.isDisposed() && item.getData("TableRow") == this;
    boolean bWidgetOk = true;
    final boolean bCheckVisibility = (checkFlags & REQUIRE_VISIBILITY) > 0;
    final boolean bCheckInitialized = (checkFlags & REQUIRE_TABLEITEM_INITIALIZED) > 0;

    if (bWidgetOk && bCheckInitialized) {
      bWidgetOk = (table.getStyle() & SWT.VIRTUAL) == 0
          || item.getData("SD") != null;
    }

    if (bWidgetOk && bCheckVisibility) {
     
      if (_isVisible()) {
        // Caller assumes that a visible item can be modified, so
        // make sure we initialize it.
        if (!bCheckInitialized && (table.getStyle() & SWT.VIRTUAL) != 0
            && item.getData("SD") == null) {
          // This is catch is temporary for SWT 3212, because there are cases where
          // it says it isn't disposed, when it really almost is
          try {
            item.setData("SD", "1");
          } catch (NullPointerException badSWT) {
          }

           //setAlternatingBGColor(false);
          setIconSize(ptIconSize);
          invalidate();
        }
      } else {
        bWidgetOk = false;
      }
    }

    return bWidgetOk;
  }
 
  private boolean _isVisible() {
    // Least time consuming checks first
   
    int index = table.indexOf(item);
    if (index == -1)
      return false;

    int iTopIndex = table.getTopIndex();
    if (index < iTopIndex)
      return false;

    int iBottomIndex = Utils.getTableBottomIndex(table, iTopIndex);
    if (index > iBottomIndex)
      return false;

    return true;
  }
 
 
  public Color
  getForeground()
  {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return null;

    return( item.getForeground());
  }
 
  public void setForeground(Color  c ){

    foreground = c;
   
    item.setForeground(foreground);
  }

  public boolean
  setForeground(
    int index,
    Color  new_color )
  {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return false;
       
    if ( index >= foreground_colors.length ){
     
      int  new_size = Math.max( index+1, foreground_colors.length+VALUE_SIZE_INC );
     
      Color[]  new_colors = new Color[new_size];
     
      System.arraycopy( foreground_colors, 0, new_colors, 0, foreground_colors.length );
     
      foreground_colors = new_colors;
    }

    Color value = foreground_colors[index];
   
    if ( new_color == value ){
     
      return false;
    }
   
    if new_color != null &&
        value != null &&
        new_color.equals( value )){
         
      return false;
    }
   
    foreground_colors[index] = new_color;

    try {
      item.setForeground(index, new_color);
    } catch (NoSuchMethodError e) {
      /* Ignore for Pre 3.0 SWT.. */
    }
   
    return true;
  }

  public Color getForeground(int index)
  {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return null;
    if (index >= foreground_colors.length)
      return item.getForeground();

    return foreground_colors[index];
  }
 
  protected String
  getText(
    int    index )
  {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return "";

    // SWT >= 3041(Win),3014(GTK),3002(Carbon) and returns "" if range check
    // fails
    return item.getText(index);
  }

  /**
   * @param index
   * @param new_value
   * @return true if the item has been updated
   */
  public boolean
  setText(
    int      index,
    String    new_value )
  {
  //  if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
  //    return false;
   
    if (index < 0 || index >= table.getColumnCount())
      return false;
   
    if (new_value == null)
      new_value = "";

    if (item.getText(index).equals(new_value))
      return false;

    item.setText( index, new_value );
   
    return true;
  }
 
  public Rectangle getBounds(int index) {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return null;

    // Some Platforms (OSX) don't handle getBounds properly (3.2M4) when
    // item doesn't exist in table
    if (table.indexOf(item) == -1)
      return null;

    Rectangle r = item.getBounds(index);
    if (r == null || r.width == 0 || r.height == 0)
      return null;

    return r;
  }

  protected Table getTable() {
    return table;
  }
 
  public Color getBackground() {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return null;
    return item.getBackground();
  }

  /**
   * The Index is this item's the position in list.
   *
   * @return Item's Position
   */
  public int getIndex() {
    if (!checkWidget(REQUIRE_TABLEITEM))
      return -1;

    return table.indexOf(item);
  }
 
  private void copyToItem(TableItem newItem) {
    Table table = getTable();
    if (table == null || item == null)
      return;

//    newItem.setText(text_values);
    newItem.setImage(image_values);
    Color colorFG = item.getForeground();
    Color colorBG = item.getBackground();
    newItem.setForeground(colorFG);
    newItem.setBackground(colorBG);
    int numColumns = table.getColumnCount();
    for (int i = 0; i < numColumns; i++) {
      try {
        newItem.setText(i, item.getText(i));
        Color colorColumnFG = item.getForeground(i);
        Color colorColumnBG = item.getBackground(i);
        if (!colorColumnFG.equals(colorFG))
          newItem.setForeground(i, colorColumnFG);
        if (!colorColumnBG.equals(colorBG))
          newItem.setBackground(i, colorColumnBG);
      } catch (NoSuchMethodError e) {
        /* Ignore for Pre 3.0 SWT.. */
      }
    }
    if (isSelected())
      table.select(table.indexOf(newItem));
    else
      table.deselect(table.indexOf(newItem));

    newItem.setData("TableRow", item.getData("TableRow"));
  }
 
  public boolean isSelected() {
    if (!checkWidget(REQUIRE_TABLEITEM))
      return false;

    // Invalid Indexes are checked/ignored by SWT.
    return table.isSelected(table.indexOf(item));
  }

  public void setSelected(boolean bSelected) {
    if (!checkWidget(REQUIRE_TABLEITEM))
      return;

    if (bSelected)
      table.select(getIndex());
    else
      table.deselect(getIndex());
  }

  /**
   * Set the TableItem associated with this row to the TableItem at the
   * specified index.
   *
   * @param newIndex Index of TableItem that will be associated with this row
   * @param bCopyFromOld True: Copy the visuals from the old TableItem to
   *                            the new TableItem
   * @return success level
   */
  public boolean setTableItem(int newIndex, boolean bCopyFromOld) {
    TableItem newRow;
    try {
      newRow = table.getItem(newIndex);
    } catch (IllegalArgumentException er) {
      if (item == null || item.isDisposed()) {
        return false;
      }
      item = null;
      return true;
    } catch (Throwable e) {
      System.out.println("setTableItem(" + newIndex + ", " + bCopyFromOld + ")");
      e.printStackTrace();
      return false;
    }

    if (newRow == item) {
      if (newRow == null || newRow.getData("TableRow") == this) {
         //setAlternatingBGColor(false);
        return false;
      }
    }

    if (newRow != null) {
      if (newRow.getParent() != table)
        return false;

      if (bCopyFromOld) {
        copyToItem(newRow);
      } else if (newRow.getData("SD") != null) {
        // clear causes too much flicker
        //table.clear(table.indexOf(newRow));
        newRow.setForeground(null);
        //newRow.setBackground(null);

        int numColumns = table.getColumnCount();
        for (int i = 0; i < numColumns; i++) {
          try {
            newRow.setForeground(i, null);
          } catch (NoSuchMethodError e) {
            /* Ignore for Pre 3.0 SWT.. */
          }
        }
       } else {
         newRow.setData("SD", "1");
       }

       setAlternatingBGColor(false);

      try {
        newRow.setData("TableRow", this);
      } catch (Exception e) {
        e.printStackTrace();
        System.out.println("Disposed? " + newRow.isDisposed());
        if (!newRow.isDisposed()) {
          System.out.println("TR? " + newRow.getData("TableRow"));
          System.out.println("SD? " + newRow.getData("SD"));
        }
      }
    }
    image_values  = new Image[0];
    foreground_colors  = new Color[0];
    foreground = null;

    // unlink old item from tablerow
    if (item != null && !item.isDisposed() && item.getData("TableRow") == this)
      item.setData("TableRow", null);

    item = newRow;
     invalidate();

    return true;
  }
 
  private Map object_list = new Hashtable();
 
  public void setData(String key,Object object) {
    object_list.put(key, object);
  }
 
  public Object getData(String key) {
    return object_list.get(key);
  }

  public boolean setHeight(int iHeight) {
    return setIconSize(new Point(1, iHeight));
  }
 
  public boolean setIconSize(Point pt) {
    ptIconSize = pt;

    if (pt == null)
      return false;
   
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED))
      return false;
   
    Image oldImage = item.getImage(0);
    if (oldImage != null) {
      Rectangle r = oldImage.getBounds();
      if (r.width == pt.x && r.height == pt.y)
        return false;
    }
   
    // set row height by setting image
    Image image = new Image(item.getDisplay(), pt.x, pt.y);
    item.setImage(0, image);
    item.setImage(0, null);
    image.dispose();
   
    return true;
  }

  /**
   * Whether the row is currently visible to the user
   *
   * @return visibility
   */
  public boolean isVisible() {
    return checkWidget(REQUIRE_VISIBILITY);
  }
 
  /**
   * Overridable function that is called when row needs invalidation.
   *
   */
  public void invalidate() {
    if (!checkWidget(REQUIRE_TABLEITEM_INITIALIZED | REQUIRE_VISIBILITY))
      return;

    Rectangle r = item.getBounds(0);

    table.redraw(0, r.y, table.getClientArea().width, r.height, true);
  }
}
TOP

Related Classes of org.jmule.ui.swt.tables.BufferedTableRow

TOP
Copyright © 2018 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.