libjava/classpath/javax/swing/text/html/Option.java

   1 /* Option.java -- Value class for <option> list model elements
   2    Copyright (C) 2006 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.swing.text.html;
  40
  41 import javax.swing.text.AttributeSet;
  42
  43 /**
  44  * Value class for the combobox model that renders <code>&lt;option&gt;</code>
  45  * elements.
  46  *
  47  * @author Roman Kennke (kennke@aicas.com)
  48  */
  49 public class Option
  50 {
  51
  52   /**
  53    * The attributes of the <option> tag.
  54    */
  55   private AttributeSet attributes;
  56
  57   /**
  58    * The label.
  59    */
  60   private String label;
  61
  62   /**
  63    * The selected state of this label.
  64    */
  65   private boolean selected;
  66
  67   /**
  68    * Creates a new <code>Option</code> instance that uses the specified
  69    * tag attributes.
  70    *
  71    * @param attr the attributes to use
  72    */
  73   public Option(AttributeSet attr)
  74   {
  75     // Protect the attribute set.
  76     attributes = attr.copyAttributes();
  77     label = null;
  78     selected = attr.getAttribute(HTML.Attribute.SELECTED) != null;
  79   }
  80
  81   /**
  82    * Sets the label to use for this <code>&lt;option&gt;</code> tag.
  83    *
  84    * @param l the label to set
  85    */
  86   public void setLabel(String l)
  87   {
  88     label = l;
  89   }
  90
  91   /**
  92    * Returns the label of this <code>&lt;option&gt;</code> tag.
  93    *
  94    * @return the label of this <code>&lt;option&gt;</code> tag
  95    */
  96   public String getLabel()
  97   {
  98     return label;
  99   }
 100
 101   /**
 102    * Returns the attributes used to render this <code>&lt;option&gt;</code>
 103    * tag.
 104    *
 105    * @return the attributes used to render this <code>&lt;option&gt;</code> tag
 106    */
 107   public AttributeSet getAttributes()
 108   {
 109     return attributes;
 110   }
 111
 112   /**
 113    * Returns a string representation of this <code>&lt;option&gt;</code> tag.
 114    * This returns the <code>label</code> property.
 115    *
 116    * @return a string representation of this <code>&lt;option&gt;</code> tag
 117    */
 118   public String toString()
 119   {
 120     return label;
 121   }
 122
 123   /**
 124    * Sets the selected state of this <code>&lt;option&gt;</code> tag.
 125    *
 126    * @param s the selected state to set
 127    */
 128   protected void setSelection(boolean s)
 129   {
 130     selected = s;
 131   }
 132
 133   /**
 134    * Returns <code>true</code> when this option is selected, <code>false</code>
 135    * otherwise.
 136    *
 137    * @return <code>true</code> when this option is selected, <code>false</code>
 138    *         otherwise
 139    */
 140   public boolean isSelected()
 141   {
 142     return selected;
 143   }
 144
 145   /**
 146    * Returns the string associated with the <code>value</code> attribute or
 147    * the label, if no such attribute is specified.
 148    *
 149    * @return the string associated with the <code>value</code> attribute or
 150    *         the label, if no such attribute is specified
 151    */
 152   public String getValue()
 153   {
 154     String value = (String) attributes.getAttribute(HTML.Attribute.VALUE);
 155     if (value == null)
 156       value = label;
 157     return value;
 158   }
 159 }