View Javadoc
   /*
    * Copyright (c) 2003 Scott Howlett & Paul Libbrecht.
    * All rights reserved.
    *
    * Redistribution and use in source and binary forms, with or without
    * modification, are permitted provided that the following conditions
    * are met:
    *
    * 1. Redistributions of source code must retain the above copyright
   *    notice, this list of conditions and the following disclaimer.
   *
   * 2. Redistributions in binary form must reproduce the above copyright
   *    notice, this list of conditions and the following disclaimer in
   *    the documentation and/or other materials provided with the
   *    distribution.
   *
   * 3. The end-user documentation included with the redistribution,
   *    if any, must include the following acknowledgment:
   *       "This product includes software developed by the Xwing
   *       Project ( http://xwing.sourceforge.net/ )."
   *    Alternately, this acknowledgment may appear in the software itself,
   *    if and wherever such third-party acknowledgments normally appear.
   *
   * 4. The name "Xwing" must not be used to endorse or promote products
   *    derived from this software without prior written permission. For
   *    written permission, please contact the project authors via
   *    the Xwing project site, http://xwing.sourceforge.net/ .
   *
   * 5. Products derived from this software may not be called "Xwing",
   *    nor may "Xwing" appear in their name, without prior written
   *    permission of the Xwing project.
   *
   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
   * DISCLAIMED.  IN NO EVENT SHALL THE XWING AUTHORS OR THE PROJECT
   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
   *
   * For more information on Xwing, please see
   * < http://xwing.sourceforge.net/ >.
   */
  package net.sourceforge.xwing.swing;
  
  import javax.swing.ListModel;
  
  import org.apache.commons.lang.builder.EqualsBuilder;
  import org.apache.commons.lang.builder.HashCodeBuilder;
  
  import net.sourceforge.xwing.SourceSink;
  import net.sourceforge.xwing.SourceSinkFactory;
  
  public class XTableColumn {
  
      private String label;
      private SourceSink labelSS;
  
      private SourceSinkFactory valueFactory;
      private boolean isEditable;
      private ListModel choices;
      private boolean isConstrainedToChoices;
  
      public XTableColumn(
          String label,
          SourceSinkFactory valueFactory,
          boolean isEditable,
          ListModel choices,
          boolean isConstrainedToChoices) {
  
          this.label = label;
          this.valueFactory = valueFactory;
          this.isEditable = isEditable;
          this.choices = choices;
          this.isConstrainedToChoices = isConstrainedToChoices;
      }
  
      public XTableColumn(
          SourceSink labelSS,
          SourceSinkFactory valueFactory,
          boolean isEditable,
          ListModel choices,
          boolean isConstrainedToChoices) {
  
          this.labelSS = labelSS;
          this.valueFactory = valueFactory;
          this.isEditable = isEditable;
          this.choices = choices;
          this.isConstrainedToChoices = isConstrainedToChoices;
      }
  
      /***
       * Returns the label that should be used for this column.
       *
      * @return the label for this column
      * @throws Exception
      */
     public String getLabel() throws Exception {
         return labelSS != null ? labelSS.get().toString() : label;
     }
 
     /***
      * An XTableModel has one context object per row. It determines
      * each of the cell values in hat row by calling getValue() on
      * each of its columns.
      *
      * @param context The row contect object
      * @return This column's cell value for  the given row.
      * @throws Exception
      */
     public SourceSink getValue(Object context) throws Exception {
         return valueFactory.create(context);
     }
 
     /***
      * Are the cell values in this column editable?
      *
      * @return true if the cell values are editable, false if they
      * are not.
      */
     public boolean isEditable() {
         return isEditable;
     }
 
     /***
      * What class do this column's cell values belong to?
      *
      * @return the class that all cell values will belong to (they will
      * be instances of either the returned class or some class derived
      * from it).
      */
     public Class getColumnClass() {
         return valueFactory.getValueClass();
     }
 
     /***
      * What set of predefined values may cells be set to?
      *
      * @return The list of enumerated values that cell values may
      * be set to, or null if there are no predefined choices.
      */
     public ListModel getChoices() {
         return choices;
     }
 
     /***
      * May cells be set to values values other than those returned
      * by getChoices?
      *
      * @return true if cell values are constrained to those enumerated
      * by getChoices, false if cells may be set to any valid instance of
      * the class specified by getColumnClass().
      */
     public boolean isConstrainedToChoices() {
         return isConstrainedToChoices;
     }
 
     public boolean equals(Object obj) {
 
         if (obj == this) {
             return true;
         }
 
         if (obj == null || obj.getClass() != getClass()) {
             return false;
         }
 
         XTableColumn other = (XTableColumn) obj;
 
         return new EqualsBuilder()
             .append(label, other.label)
             .append(labelSS, other.labelSS)
             .append(valueFactory, other.valueFactory)
             .append(isEditable, other.isEditable)
             .append(choices, other.choices)
             .append(isConstrainedToChoices, other.isConstrainedToChoices)
             .isEquals();
     }
 
     public int hashCode() {
         return new HashCodeBuilder()
             .append(label)
             .append(labelSS)
             .append(valueFactory)
             .append(isEditable)
             .append(choices)
             .append(isConstrainedToChoices)
             .toHashCode();
     }
 
     public void setChoices(ListModel choices) {
         this.choices = choices;
     }
 
     public void setConstrainedToChoices(boolean isConstrainedToChoices) {
         this.isConstrainedToChoices = isConstrainedToChoices;
     }
 
     public void setEditable(boolean isEditable) {
         this.isEditable = isEditable;
     }
 
     public void setLabel(String label) {
         this.label = label;
         this.labelSS = null;
     }
 
     public void setLabelSS(SourceSink labelSS) {
         this.labelSS = labelSS;
         this.label = null;
     }
 
 }