com.sas.servlet.tbeans.form.html
Class Image

com.sas.servlet.tbeans.form.html.Image
All Implemented Interfaces:
com.sas.beans.PropertyChangeSource, com.sas.lang.ObjectDataInterface, FormElementModificationEventInterface, com.sas.servlet.tbeans.form.JavaScriptObjectCreationInterface, com.sas.servlet.tbeans.JavaScriptEventHandlerInterface, RenderableInterface, com.sas.servlet.tbeans.ScriptActivatedInterface, StyleInterface, com.sas.servlet.tbeans.TitleInterface, TransformationInterface, URLInterface, GenericValidatorInterface, com.sas.util.WriteToPrintWriterInterface, java.io.Serializable
Direct Known Subclasses:
CellContentsImageRenderer

public class Image
implements StyleInterface, com.sas.servlet.tbeans.ScriptActivatedInterface

The Image is a TransformationBean™ that generates the appropriate HTML 4.0 INPUT tag attributes to represent an image in a form or ANCHOR tag attributes to represent an image. You can use Image beans in a Java servlet or in a JSP scriplet. If the Image bean is used as a form element, it must be used inside of a form tag, which is either contained in the servlet or JSP page, or generated by the Form TransformationBean.

The default borderWidth for the Image TransformationBean is 0.

Accessibility

The Section 508 Accessibility standards, such as making application tasks available through the keyboard, are incorporated into our components to improve usability for all of our software products which benefits every SAS user.

This component is fully compliant with the Web-based standards outlined in Section 508. The compliance is based on producing the correct output, having keyboard equivalent and surfacing the necessary properties to assist consumers of the component to be compliant.

The following keyboard equivalents are supported by this component:
KeyBoard AccessBehavior/Result
TAB TAB moves the focus to the image. Hitting TAB while the image has focus will navigate focus to the next tabbable component.
ALT+ACCESSKEY Pressing ALT+ACCESSKEY will navigate focus to the image. The ACCESSKEY indicates the keyboard character used as a shortcut to activate the element.
ENTER Pressing the ENTER key while the image has focus will launch any command associated with the image.

The following properties are provided to assist in making the application using this component accessible:

The Image is one of several TransformationBeans™ that rely on a set of style classes that are used by default when generating the resulting markup language. For more information on style sheets and the default style classes that apply to this TransformationBean™, refer to the AppDev Studio Developer Site. You'll find a useful reference document entitled Cascading Style Sheets, Images, and TransformationBeans™ as well as the TransformationBeans™ Style Sheet Reference.

Note that the toString() method on this class calls the write method, which may have undesirable side effects. See BaseTransformation.toString() for more information. Debuggers often use toString() to show the value of a variable, and this may cause unexpected behavior while debugging

For More Information:

Visit the AppDev Studio Developer's Site to access step-by-step examples, white papers and additional usage information at http://support.sas.com/rnd/appdev/.

Examples for this class may be found on the Examples Site.

JSP custom tags provide an alternative to using the TransformationBeans™. Visit the Custom Tag Library Reference for additional information on the sas:Image custom tag.

Note: A snapshot of the AppDev Studio Developers Site is installed on your local Web server when you install AppDev Studio. To access the site from webAF, select Help -> Developer Site .

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.sas.servlet.tbeans.form.BaseFormElement
RB_KEY
 
Constructor Summary
Image()
          Constructs a new Image Transformation Bean
Image(java.lang.String name)
          Constructs a new Image Transformation Bean
Image(java.lang.String name, java.lang.String image)
          Constructs a new Image Transformation Bean
Image(java.lang.String name, java.lang.String image, int width, int height)
          Constructs a new Image Transformation Bean
 
Method Summary
 void write(java.io.PrintWriter out)
          Writes the transformed representation of the object
 
Methods inherited from class com.sas.servlet.tbeans.form.BaseImage
getAlignment, getAlternateText, getBorderWidth, getHeight, getHeightPercentage, getHorizontalSpace, getImage, getTarget, getURL, getUseAsFormElement, getVerticalSpace, getWidth, getWidthPercentage, setAlignment, setAlternateText, setBorderWidth, setHeight, setHeightPercentage, setHorizontalSpace, setImage, setTarget, setURL, setUseAsFormElement, setVerticalSpace, setWidth, setWidthPercentage
 
Methods inherited from class com.sas.servlet.tbeans.form.BaseFormElement
getAccessKey, getErrorHandler, getModificationEventName, getName, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyleInfo, getTabIndex, getTitle, getValidationFunctions, getValidator, isEnabled, isValid, isValidationEnabled, setAccessKey, setEnabled, setErrorHandler, setId, setModificationEventName, setName, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setStyleInfo, setTabIndex, setTitle, setValidator, writeJavaScriptObject, writeJavaScriptObjectValidate, writeJavaScriptValidatorObject, writeValidationScript
 
Methods inherited from class com.sas.servlet.tbeans.BaseTransformation
addPropertyChangeListener, addPropertyChangeListener, cleanUpResources, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getCustomAttributes, getDescription, getId, getInputTransform, getLocale, getObjectData, getObjectDataProperty, getOutputTransform, getRequest, getResponse, getTagEpilog, getTagProlog, hasListeners, isCleanUpResourcesOn, isVisible, removePropertyChangeListener, removePropertyChangeListener, setCleanUpResourcesOn, setCustomAttributes, setDescription, setInputTransform, setLocale, setLocaleDependentProperties, setObjectData, setObjectDataProperty, setOutputTransform, setRequest, setResponse, setTagEpilog, setTagProlog, setVisible, toString, write, write, write
 
Methods inherited from interface com.sas.servlet.tbeans.StyleInterface
getStyleInfo, setStyleInfo
 

Constructor Detail

Image

public Image()
Constructs a new Image Transformation Bean


Image

public Image(java.lang.String name)
Constructs a new Image Transformation Bean

Parameters:
name - The image name

Image

public Image(java.lang.String name,
             java.lang.String image)
Constructs a new Image Transformation Bean

Parameters:
name - The image field name
image - The image source

Image

public Image(java.lang.String name,
             java.lang.String image,
             int width,
             int height)
Constructs a new Image Transformation Bean

Parameters:
name - The image field name
image - The image source
width - The image width
height - The image height
Method Detail

write

public void write(java.io.PrintWriter out)
           throws java.io.IOException
Writes the transformed representation of the object

Specified by:
write in interface TransformationInterface
Specified by:
write in interface com.sas.util.WriteToPrintWriterInterface
Overrides:
write in class BaseFormElement
Parameters:
out - The output stream
Throws:
java.io.IOException - Thrown if some type of I/O error occurs



Copyright © 2009 SAS Institute Inc. All Rights Reserved.