Option (Java Platform SE 6)

This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.

Overview

Package

Class

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.swing.text.html
class Option

java.lang.Object
  javax.swing.text.html.Option

All Implemented Interfaces:: Serializable

public class Option
extends Object
implements Serializable

Value for the ListModel used to represent <option> elements. This is the object installed as items of the DefaultComboBoxModel used to represent the <select> element.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

Constructor Summary
`Option(AttributeSet attr)` Creates a new Option object.

Method Summary
`AttributeSet`	`getAttributes()` Fetch the attributes associated with this option.
`String`	`getLabel()` Fetch the label associated with the option.
`String`	`getValue()` Convenience method to return the string associated with the `value` attribute.
`boolean`	`isSelected()` Fetches the selection state associated with this option.
`void`	`setLabel(String label)` Sets the label to be used for the option.
`protected void`	`setSelection(boolean state)` Sets the selected state.
`String`	`toString()` String representation is the label.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

Option

public Option(AttributeSet attr)

Creates a new Option object.

Parameters:: attr - the attributes associated with the option element. The attributes are copied to ensure they won't change.

Method Detail

getAttributes

public AttributeSet getAttributes()

Fetch the attributes associated with this option.

getLabel

public String getLabel()

Fetch the label associated with the option.

getValue

public String getValue()

Convenience method to return the string associated with the value attribute. If the value has not been specified, the label will be returned.

isSelected

public boolean isSelected()

Fetches the selection state associated with this option.

setLabel

public void setLabel(String label)

Sets the label to be used for the option.

Parameters:: label

setSelection

protected void setSelection(boolean state)

Sets the selected state.

Parameters:: state

toString

public String toString()

String representation is the label.

Overrides:: toString in class Object