001/* Option.java -- Value class for <option> list model elements
002   Copyright (C) 2006 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.text.html;
040
041import javax.swing.text.AttributeSet;
042
043/**
044 * Value class for the combobox model that renders <code>&lt;option&gt;</code>
045 * elements.
046 *
047 * @author Roman Kennke (kennke@aicas.com)
048 */
049public class Option
050{
051
052  /**
053   * The attributes of the <option> tag.
054   */
055  private AttributeSet attributes;
056
057  /**
058   * The label.
059   */
060  private String label;
061
062  /**
063   * The selected state of this label.
064   */
065  private boolean selected;
066
067  /**
068   * Creates a new <code>Option</code> instance that uses the specified
069   * tag attributes.
070   *
071   * @param attr the attributes to use
072   */
073  public Option(AttributeSet attr)
074  {
075    // Protect the attribute set.
076    attributes = attr.copyAttributes();
077    label = null;
078    selected = attr.getAttribute(HTML.Attribute.SELECTED) != null;
079  }
080
081  /**
082   * Sets the label to use for this <code>&lt;option&gt;</code> tag.
083   *
084   * @param l the label to set
085   */
086  public void setLabel(String l)
087  {
088    label = l;
089  }
090
091  /**
092   * Returns the label of this <code>&lt;option&gt;</code> tag.
093   *
094   * @return the label of this <code>&lt;option&gt;</code> tag
095   */
096  public String getLabel()
097  {
098    return label;
099  }
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}