src.com.ibm.as400.util.html.ImageFormInput Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jt400 Show documentation
Show all versions of jt400 Show documentation
The Open Source version of the IBM Toolbox for Java
///////////////////////////////////////////////////////////////////////////////
//
// JTOpen (IBM Toolbox for Java - OSS version)
//
// Filename: ImageFormInput.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-2001 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.PropertyVetoException;
/**
* The ImageFormInput class represents a image input type in an HTML form.
* The trailing slash "/" on the ImageFormInput tag allows it to conform to
* the XHTML specification.
*
* Here is an example of a ImageFormInput tag:
* <input type="image" name="myPicture" src="image.gif"
* align="top" height="100" width="100" />
*
*
ImageFormInput objects generate the following events:
*
* - PropertyChangeEvent
*
- VetoableChangeEvent
*
**/
public class ImageFormInput extends FormInput implements HTMLConstants
{
private static final String copyright = "Copyright (C) 1997-2001 International Business Machines Corporation and others.";
static final long serialVersionUID = 3208810620206338498L;
private int height_ = 0; // The image height.
private int width_ = 0; // The image width.
private String align_; // The image text alignment.
private String source_; // The image source URL.
/**
* Constructs a default ImageFormInput object.
**/
public ImageFormInput()
{
super();
align_ = TOP; // default alignment
}
/**
* Constructs a ImageFormInput object with the specified control name.
* @param name The control name of the input field.
**/
public ImageFormInput(String name)
{
super(name); // default alignment
align_ = TOP;
}
/**
* Constructs a ImageFormInput object with the specified control name and
* image source.
* @param name The control name of the input field.
* @param source The source URL of the image.
**/
public ImageFormInput(String name, String source)
{
super(name);
align_ = TOP; // default alignment
try
{
setSource(source);
}
catch (PropertyVetoException e)
{
}
}
/**
* Returns the alignment of the text following the image.
* @return The alignment. One of the following constants
* defined in HTMLConstants: BASELINE, BOTTOM, ABSBOTTOM, LEFT, RIGHT,
* MIDDLE, ABSMIDDLE, TOP, or TEXTOP.
*
* @see com.ibm.as400.util.html.HTMLConstants
**/
public String getAlignment()
{
return align_;
}
/**
* Returns the attribute tag.
* @return The tag.
**/
private String getAttributeTag()
{
//@C1D
StringBuffer s = new StringBuffer("");
if ((source_ != null) && (source_.length() > 0))
s.append(" src=\"" + source_ + "\"");
s.append(" align=\"");
s.append(align_);
s.append("\"");
if (height_ > 0)
{
if (Trace.isTraceOn())
Trace.log(Trace.INFORMATION, " Using height attribute tag.");
s.append(" height=\"" + height_ + "\"");
}
if (width_ > 0)
{
if (Trace.isTraceOn())
Trace.log(Trace.INFORMATION, " Using width attribute tag.");
s.append(" width=\"" + width_ + "\"");
}
return s.toString();
}
/**
* Returns the height of the image in pixels.
* @return The height.
**/
public int getHeight()
{
return height_;
}
/**
* Returns the source URL for the image.
* @return The URL.
**/
public String getSource()
{
return source_;
}
/**
* 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 tag for the image form input type.
* @return The tag.
**/
public String getTag()
{
//@C1D
if (getName() == null)
{
Trace.log(Trace.ERROR, "Attempting to get tag before setting name.");
throw new ExtendedIllegalStateException(
"name", ExtendedIllegalStateException.PROPERTY_NOT_SET );
}
if (getSource() == null)
{
Trace.log(Trace.ERROR, "Attempting to get tag before setting source.");
throw new ExtendedIllegalStateException(
"source", ExtendedIllegalStateException.PROPERTY_NOT_SET );
}
StringBuffer s = new StringBuffer("");
return s.toString();
}
/**
* Returns the width of the image in pixels.
* @return The width.
**/
public int getWidth()
{
return width_;
}
/**
* Sets the alignment of the text following the image. The default
* alignment is top.
* @param align The alignment. One of the following constants
* defined in HTMLConstants: BASELINE, BOTTOM, ABSBOTTOM, LEFT, RIGHT,
* MIDDLE, ABSMIDDLE, TOP, or TEXTOP.
*
* @exception PropertyVetoException If a change is vetoed.
* @see com.ibm.as400.util.html.HTMLConstants
**/
public void setAlignment(String align)
throws PropertyVetoException
{
if (align == null)
throw new NullPointerException("align");
// If align is not one of the valid HTMLConstants, throw an exception.
if ( !(align.equals(BASELINE)) && !(align.equals(BOTTOM)) && !(align.equals(ABSBOTTOM)) &&
!(align.equals(LEFT)) && !(align.equals(RIGHT)) && !(align.equals(MIDDLE)) &&
!(align.equals(ABSMIDDLE)) && !(align.equals(TOP)) && !(align.equals(TEXTTOP)) )
{
throw new ExtendedIllegalArgumentException("align", ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
}
String old = align_;
if (vetos_ != null) vetos_.fireVetoableChange("align", old, align); //@CRS
align_ = align;
if (changes_ != null) changes_.firePropertyChange("align", old, align); //@CRS
}
/**
* Sets the height of the image in pixels.
* @param height The height.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setHeight(int height)
throws PropertyVetoException
{
if (height < 0 )
throw new ExtendedIllegalArgumentException("height", ExtendedIllegalArgumentException.RANGE_NOT_VALID);
int old = height_;
if (vetos_ != null) vetos_.fireVetoableChange("height", new Integer(old), new Integer(height) ); //@CRS
height_ = height;
if (changes_ != null) changes_.firePropertyChange("height", new Integer(old), new Integer(height) ); //@CRS
}
/**
* Sets the source URL for the image.
* @param source The URL.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setSource(String source)
throws PropertyVetoException
{
if (source == null)
throw new NullPointerException("source");
if (source.length() == 0)
throw new ExtendedIllegalArgumentException("source",
ExtendedIllegalArgumentException.PARAMETER_VALUE_NOT_VALID);
String old = source_;
if (vetos_ != null) vetos_.fireVetoableChange("source", old, source ); //@CRS
source_ = source;
if (changes_ != null) changes_.firePropertyChange("source", old, source ); //@CRS
}
/**
* Sets the width of the image in pixels.
* @param width The width.
*
* @exception PropertyVetoException If a change is vetoed.
**/
public void setWidth(int width)
throws PropertyVetoException
{
if (width < 0)
throw new ExtendedIllegalArgumentException("width", ExtendedIllegalArgumentException.RANGE_NOT_VALID);
int old = width_;
if (vetos_ != null) vetos_.fireVetoableChange("width", new Integer(old), new Integer(width) ); //@CRS
width_ = width;
if (changes_ != null) changes_.firePropertyChange("width", new Integer(old), new Integer(width) ); //@CRS
}
}