< prev index next >
src/java.desktop/share/classes/javax/swing/SpinnerModel.java
Print this page
@@ -29,35 +29,35 @@
import javax.swing.event.*;
/**
* A model for a potentially unbounded sequence of object values. This model
- * is similar to <code>ListModel</code> however there are some important differences:
+ * is similar to {@code ListModel} however there are some important differences:
* <ul>
* <li> The number of sequence elements isn't necessarily bounded.
* <li> The model doesn't support indexed random access to sequence elements.
* Only three sequence values are accessible at a time: current, next and
* previous.
* <li> The current sequence element, can be set.
* </ul>
* <p>
- * A <code>SpinnerModel</code> has three properties, only the first is read/write.
+ * A {@code SpinnerModel} has three properties, only the first is read/write.
* <dl>
- * <dt><code>value</code>
+ * <dt>{@code value}
* <dd>The current element of the sequence.
*
- * <dt><code>nextValue</code>
- * <dd>The following element or null if <code>value</code> is the
+ * <dt>{@code nextValue}
+ * <dd>The following element or null if {@code value} is the
* last element of the sequence.
*
- * <dt><code>previousValue</code>
- * <dd>The preceding element or null if <code>value</code> is the
+ * <dt>{@code previousValue}
+ * <dd>The preceding element or null if {@code value} is the
* first element of the sequence.
* </dl>
- * When the <code>value</code> property changes,
- * <code>ChangeListeners</code> are notified. <code>SpinnerModel</code> may
- * choose to notify the <code>ChangeListeners</code> under other circumstances.
+ * When the {@code value} property changes,
+ * {@code ChangeListeners} are notified. {@code SpinnerModel} may
+ * choose to notify the {@code ChangeListeners} under other circumstances.
*
* @see JSpinner
* @see AbstractSpinnerModel
* @see SpinnerListModel
* @see SpinnerNumberModel
@@ -68,72 +68,72 @@
*/
public interface SpinnerModel
{
/**
* The <i>current element</i> of the sequence. This element is usually
- * displayed by the <code>editor</code> part of a <code>JSpinner</code>.
+ * displayed by the {@code editor} part of a {@code JSpinner}.
*
* @return the current spinner value.
* @see #setValue
*/
Object getValue();
/**
* Changes current value of the model, typically this value is displayed
- * by the <code>editor</code> part of a <code>JSpinner</code>.
- * If the <code>SpinnerModel</code> implementation doesn't support
- * the specified value then an <code>IllegalArgumentException</code>
- * is thrown. For example a <code>SpinnerModel</code> for numbers might
+ * by the {@code editor} part of a {@code JSpinner}.
+ * If the {@code SpinnerModel} implementation doesn't support
+ * the specified value then an {@code IllegalArgumentException}
+ * is thrown. For example a {@code SpinnerModel} for numbers might
* only support values that are integer multiples of ten. In
- * that case, <code>model.setValue(new Number(11))</code>
+ * that case, {@code model.setValue(new Number(11))}
* would throw an exception.
*
* @param value new value for the spinner
- * @throws IllegalArgumentException if <code>value</code> isn't allowed
+ * @throws IllegalArgumentException if {@code value} isn't allowed
* @see #getValue
*/
void setValue(Object value);
/**
* Return the object in the sequence that comes after the object returned
- * by <code>getValue()</code>. If the end of the sequence has been reached
- * then return null. Calling this method does not effect <code>value</code>.
+ * by {@code getValue()}. If the end of the sequence has been reached
+ * then return null. Calling this method does not effect {@code value}.
*
* @return the next legal value or null if one doesn't exist
* @see #getValue
* @see #getPreviousValue
*/
Object getNextValue();
/**
* Return the object in the sequence that comes before the object returned
- * by <code>getValue()</code>. If the end of the sequence has been reached then
- * return null. Calling this method does not effect <code>value</code>.
+ * by {@code getValue()}. If the end of the sequence has been reached then
+ * return null. Calling this method does not effect {@code value}.
*
* @return the previous legal value or null if one doesn't exist
* @see #getValue
* @see #getNextValue
*/
Object getPreviousValue();
/**
- * Adds a <code>ChangeListener</code> to the model's listener list. The
- * <code>ChangeListeners</code> must be notified when models <code>value</code>
+ * Adds a {@code ChangeListener} to the model's listener list. The
+ * {@code ChangeListeners} must be notified when models {@code value}
* changes.
*
* @param l the ChangeListener to add
* @see #removeChangeListener
*/
void addChangeListener(ChangeListener l);
/**
- * Removes a <code>ChangeListener</code> from the model's listener list.
+ * Removes a {@code ChangeListener} from the model's listener list.
*
* @param l the ChangeListener to remove
* @see #addChangeListener
*/
void removeChangeListener(ChangeListener l);
< prev index next >