Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.RuntimeCollective.webapps.tag
Class HtmlInputTag  view HtmlInputTag download HtmlInputTag.java

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.RuntimeCollective.webapps.tag.HtmlInputTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag
Direct Known Subclasses:
HtmlInputJSTag, HtmlInputPostTag

public abstract class HtmlInputTag
extends javax.servlet.jsp.tagext.TagSupport

An abstract class for custom JSP tags that display a Java applet for WSIWYG editing of HTML.

This class must be extended to provide methods for what applet class to use, what parameters to send in, and what script snippets (if any) are necessary.

IMPORTANT: This tag must be used inside a form, and the form creation tag must contain onsubmit="return getHTMLEditorAppletValue()", for example:

<html:form action="/testHtmlAction" onsubmit="return getHTMLEditorAppletValue()">

Only one HtmlInputTag can be used per HTML page.

This tag takes the following attributes:

Version:
$Id: HtmlInputTag.java,v 1.5 2003/09/30 15:13:18 joe Exp $

Field Summary
protected  int columns
          The columns
protected  int height
          The height
protected  java.lang.String name
          The form bean name.
protected  java.lang.String property
          The property name that stores the HTML generated by the applet.
protected  int rows
          The rows
protected  int width
          The width
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
HtmlInputTag()
           
 
Method Summary
 int doStartTag()
          Default processing of the start tag, returning SKIP_BODY.
abstract  java.lang.String getAppletClass()
          Get the name of the Applet class to use
 int getColumns()
          Get the columns
 java.lang.String[][] getExtraParameters()
           
 int getHeight()
          Get the height
 java.lang.String getName()
          Get the form bean name.
protected  java.lang.String getParsedExtraParameters(boolean useEmbedStyle)
          Go through all the parameters set by the implementing class, and build them up in a String, depending what kind of applet tags we're using
 java.lang.String getProperty()
          Get the property name.
 int getRows()
          Get the rows
 java.lang.String getScript()
          Get any scripting functions (eg some Javascript) that have to be defined for the applet to work.
 int getWidth()
          Get the width
 void setColumns(int columns)
          Set the columns
 void setHeight(int height)
          Set the height
 void setName(java.lang.String name)
          Set the form bean name.
 void setProperty(java.lang.String property)
          Set the property name.
 void setRows(int rows)
          Set the rows
 void setWidth(int width)
          Set the width
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

property

protected java.lang.String property
The property name that stores the HTML generated by the applet. Must be of type String.


name

protected java.lang.String name
The form bean name.


width

protected int width
The width


height

protected int height
The height


rows

protected int rows
The rows


columns

protected int columns
The columns

Constructor Detail

HtmlInputTag

public HtmlInputTag()
Method Detail

getProperty

public java.lang.String getProperty()
Get the property name.


setProperty

public void setProperty(java.lang.String property)
Set the property name.


getName

public java.lang.String getName()
Get the form bean name.


setName

public void setName(java.lang.String name)
Set the form bean name.


getWidth

public int getWidth()
Get the width


setWidth

public void setWidth(int width)
Set the width


getHeight

public int getHeight()
Get the height


setHeight

public void setHeight(int height)
Set the height


getRows

public int getRows()
Get the rows


setRows

public void setRows(int rows)
Set the rows


getColumns

public int getColumns()
Get the columns


setColumns

public void setColumns(int columns)
Set the columns


doStartTag

public final int doStartTag()
                     throws javax.servlet.jsp.JspException
Description copied from class: javax.servlet.jsp.tagext.TagSupport
Default processing of the start tag, returning SKIP_BODY.


getAppletClass

public abstract java.lang.String getAppletClass()
Get the name of the Applet class to use


getScript

public java.lang.String getScript()
Get any scripting functions (eg some Javascript) that have to be defined for the applet to work. Unless overridden, returns the empty string.


getParsedExtraParameters

protected java.lang.String getParsedExtraParameters(boolean useEmbedStyle)
Go through all the parameters set by the implementing class, and build them up in a String, depending what kind of applet tags we're using


getExtraParameters

public java.lang.String[][] getExtraParameters()