src.com.ibm.as400.util.html.SelectOption Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400-jdk8 Show documentation
Show all versions of jt400-jdk8 Show documentation
The Open Source version of the IBM Toolbox for Java
The newest version!
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: SelectOption.java
//
// The source code contained herein is licensed under the IBM Public License
// Version 1.0, which has been approved by the Open Source Initiative.
// Copyright (C) 1997-2000 International Business Machines Corporation and
// others. All rights reserved.
//
///////////////////////////////////////////////////////////////////////////////
package com.ibm.as400.util.html;
import com.ibm.as400.access.Trace;
import com.ibm.as400.access.ExtendedIllegalStateException;
import com.ibm.as400.access.ExtendedIllegalArgumentException;
import java.beans.PropertyChangeSupport;
import java.beans.PropertyChangeListener;
import java.beans.VetoableChangeSupport;
import java.beans.VetoableChangeListener;
import java.beans.PropertyVetoException;
/**
* The SelectOption class represents an option in an HTML option form element.
* The option form element is then used in an HTML select form element, which represents a group of
* selectable options. The trailing slash "/" on the SelectOption tag allows it to conform to
* the XHTML specification.
*
* This example creates a SelectOption object named item1 that is initially selected.
*
*
* SelectOption item1 = new SelectOption("Item1", "item1", true);
* System.out.println(item1.getTag());
*
*
* Here is the output of the SelectOption tag:
*
* <option value="item1" selected="selected">Item1</option>
*
*
* SelectOption objects generate the following events:
*
* - PropertyChangeEvent
*
- VetoableChangeEvent
*
*
* @see com.ibm.as400.util.html.SelectFormElement
**/
public class SelectOption extends HTMLTagAttributes implements java.io.Serializable // @Z1C
{
private static final String copyright = "Copyright (C) 1997-2000 International Business Machines Corporation and others.";
static final long serialVersionUID = -3056147198368434425L;
private String value_; // The option value.
private boolean selected_; // Whether the option defaults as selected.
private String text_; // The option text.
private String lang_; // The primary language used to display the tags contents. //$B1A
private String dir_; // The direction of the text interpretation. //$B1A
transient private VetoableChangeSupport vetos_; //@CRS
/**
* Constructs a default SelectOption object.
**/
public SelectOption()
{
super();
selected_ = false;
}
/**
* Constructs a SelectOption object with the specified viewable text and initial
* input value. By default, the option is not selected.
* @param text The veiwable option text.
* @param value The input value used when the field is submitted.
**/
public SelectOption(String text, String value)
{
super();
try
{
setValue(value);
setText(text);
}
catch (PropertyVetoException e)
{
}
}
/**
* Constructs a SelectOption object with the specified viewable text,
* initial input value, and initial selected value.
* @param text The viewable option text.
* @param value The input value used when the field is submitted.
* @param selected Whether the option defaults as being selected.
**/
public SelectOption(String text, String value, boolean selected)
{
super();
try
{
setValue(value);
setSelected(selected);
setText(text);
}
catch (PropertyVetoException e)
{
}
}
/**
Adds the VetoableChangeListener. The specified VetoableChangeListener's
vetoableChange method will be called each time the value of any
constrained property is changed.
@see #removeVetoableChangeListener
@param listener The VetoableChangeListener.
**/
public void addVetoableChangeListener(VetoableChangeListener listener)
{
if (listener == null)
throw new NullPointerException ("listener");
if (vetos_ == null) vetos_ = new VetoableChangeSupport(this);
vetos_.addVetoableChangeListener(listener);
}
/**
* Returns the direction of the text interpretation.
* @return The direction of the text.
**/
public String getDirection() //$B1A
{
return dir_;
}
/**
* Returns the language of the input element.
* @return The language of the input element.
**/
public String getLanguage() //$B1A
{
return lang_;
}
/**
* Returns a comment tag.
* This method should not be called. There is no XSL-FO support for this class.
* @return The comment tag.
**/
public String getFOTag() //@D1A
{
Trace.log(Trace.ERROR, "Attempting to getFOTag() for an object that doesn't support it.");
return "";
}
/**
* Returns the select option tag.
* @return The tag.
**/
public String getTag()
{
return getTag(text_);
}
/**
* Returns the select option tag with the new viewable option text.
* The original text of the select option object is not changed/updated.
* @param text The new option text.
* @return The tag.
**/
public String getTag(String text)
{
//@C1D
StringBuffer s = new StringBuffer(" 0)) //$B1A
{
//$B1A
if (Trace.isTraceOn()) //$B1A
Trace.log(Trace.INFORMATION, " Using language attribute."); //$B1A
//$B1A
s.append(" lang=\""); //$B1A
s.append(lang_); //$B1A
s.append("\""); //$B1A
} //$B1A
if ((dir_ != null) && (dir_.length() > 0)) //$B1A
{
//$B1A
if (Trace.isTraceOn()) //$B1A
Trace.log(Trace.INFORMATION, " Using direction attribute."); //$B1A
//$B1A
s.append(" dir=\""); //$B1A
s.append(dir_); //$B1A
s.append("\""); //$B1A
} //$B1A
s.append(getAttributeString()); // @Z1A
s.append(">");
if (text == null)
{
Trace.log(Trace.ERROR, "Parameter 'text' is null.");
throw new ExtendedIllegalStateException(
"text", ExtendedIllegalStateException.PROPERTY_NOT_SET );
}
else
s.append(text);
s.append("");
return s.toString();
}
/**
* Returns the viewable option text.
* @return The option text.
**/
public String getText()
{
return text_;
}
/**
* Returns the input value used when the field is submitted.
* @return The input value.
**/
public String getValue()
{
return value_;
}
/**
* Indicates if the option defaults to being selected.
* @return true if defaults as selected; false otherwise.
**/
public boolean isSelected()
{
return selected_;
}
/**
* Deserializes and initializes transient data.
**/
private void readObject(java.io.ObjectInputStream in) //$A1A
throws java.io.IOException, ClassNotFoundException
{
in.defaultReadObject();
//@CRS changes_ = new PropertyChangeSupport(this);
//@CRS vetos_ = new VetoableChangeSupport(this);
}
/**
Removes the PropertyChangeListener from the internal list.
If the PropertyChangeListener is not on the list, nothing is done.
@see #addPropertyChangeListener
@param listener The PropertyChangeListener.
**/
public void removePropertyChangeListener(PropertyChangeListener listener)
{
if (listener == null)
throw new NullPointerException ("listener");
if (changes_ != null) changes_.removePropertyChangeListener(listener); //@CRS
}
/**
Removes the VetoableChangeListener from the internal list.
If the VetoableChangeListener is not on the list, nothing is done.
@see #addVetoableChangeListener
@param listener The VetoableChangeListener.
**/
public void removeVetoableChangeListener(VetoableChangeListener listener)
{
if (listener == null)
throw new NullPointerException ("listener");
if (vetos_ != null) vetos_.removeVetoableChangeListener(listener); //@CRS
}
/**
* Sets the direction of the text interpretation.
* @param dir The direction. One of the following constants
* defined in HTMLConstants: LTR or RTL.
*
* @see com.ibm.as400.util.html.HTMLConstants
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setDirection(String dir) //$B1A
throws PropertyVetoException
{
if (dir == null)
throw new NullPointerException("dir");
// If direction is not one of the valid HTMLConstants, throw an exception.
if ( !(dir.equals(HTMLConstants.LTR)) && !(dir.equals(HTMLConstants.RTL)) )
{
throw new ExtendedIllegalArgumentException("dir", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
String old = dir_;
if (vetos_ != null) vetos_.fireVetoableChange("dir", old, dir ); //@CRS
dir_ = dir;
if (changes_ != null) changes_.firePropertyChange("dir", old, dir ); //@CRS
}
/**
* Sets the language of the input tag.
* @param lang The language. Example language tags include:
* en and en-US.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setLanguage(String lang) //$B1A
throws PropertyVetoException
{
if (lang == null)
throw new NullPointerException("lang");
String old = lang_;
if (vetos_ != null) vetos_.fireVetoableChange("lang", old, lang ); //@CRS
lang_ = lang;
if (changes_ != null) changes_.firePropertyChange("lang", old, lang ); //@CRS
}
/**
* Sets whether the option defaults as being selected.
* @param selected Whether the option defaults as selected.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setSelected(boolean selected)
throws PropertyVetoException
{
//@C1D
boolean old = selected_;
if (vetos_ != null) vetos_.fireVetoableChange("selected", new Boolean(old), new Boolean(selected) ); //@CRS
selected_ = selected;
if (changes_ != null) changes_.firePropertyChange("selected", new Boolean(old), new Boolean(selected) ); //@CRS
}
/**
* Sets the option text with the specified viewable text.
* @param text The option text.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setText(String text)
throws PropertyVetoException
{
if (text == null)
throw new NullPointerException("text");
String old = text_;
if (vetos_ != null) vetos_.fireVetoableChange("text", old, text ); //@CRS
text_ = text;
if (changes_ != null) changes_.firePropertyChange("text", old, text ); //@CRS
}
/**
* Sets the input value used when the field is submitted.
* @param value The input value.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setValue(String value)
throws PropertyVetoException
{
if (value == null)
throw new NullPointerException("value");
String old = value_;
if (vetos_ != null) vetos_.fireVetoableChange("value", old, value ); //@CRS
value_ = value;
if (changes_ != null) changes_.firePropertyChange("value", old, value ); //@CRS
}
/**
* Returns the String representation of the select option tag.
* @return The tag.
**/
public String toString()
{
return getTag();
}
}