Java Doc for SimpleTagSupport.java in  » 6.0-JDK-Core » Servlet-API-by-tomcat » javax » servlet » jsp » tagext » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Home
Java Source Code / Java Documentation
1.6.0 JDK Core
2.6.0 JDK Modules
3.6.0 JDK Modules com.sun
4.6.0 JDK Modules com.sun.java
5.6.0 JDK Modules sun
6.6.0 JDK Platform
7.Ajax
8.Apache Harmony Java SE
9.Aspect oriented
10.Authentication Authorization
11.Blogger System
12.Build
13.Byte Code
14.Cache
15.Chart
16.Chat
17.Code Analyzer
18.Collaboration
19.Content Management System
20.Database Client
21.Database DBMS
22.Database JDBC Connection Pool
23.Database ORM
24.Development
25.EJB Server
26.ERP CRM Financial
27.ESB
28.Forum
29.Game
30.GIS
31.Graphic 3D
32.Graphic Library
33.Groupware
34.HTML Parser
35.IDE
36.IDE Eclipse
37.IDE Netbeans
38.Installer
39.Internationalization Localization
40.Inversion of Control
41.Issue Tracking
42.J2EE
43.J2ME
44.JBoss
45.JMS
46.JMX
47.Library
48.Mail Clients
49.Music
50.Net
51.Parser
52.PDF
53.Portal
54.Profiler
55.Project Management
56.Report
57.RSS RDF
58.Rule Engine
59.Science
60.Scripting
61.Search Engine
62.Security
63.Sevlet Container
64.Source Control
65.Swing Library
66.Template Engine
67.Test Coverage
68.Testing
69.UML
70.Web Crawler
71.Web Framework
72.Web Mail
73.Web Server
74.Web Services
75.Web Services apache cxf 2.2.6
76.Web Services AXIS2
77.Wiki Engine
78.Workflow Engines
79.XML
80.XML UI
Java Source Code / Java Documentation » 6.0 JDK Core » Servlet API by tomcat » javax.servlet.jsp.tagext 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   javax.servlet.jsp.tagext.SimpleTagSupport

SimpleTagSupport
public class SimpleTagSupport implements SimpleTag(Code)
A base class for defining tag handlers implementing SimpleTag.

The SimpleTagSupport class is a utility class intended to be used as the base class for new simple tag handlers. The SimpleTagSupport class implements the SimpleTag interface and adds additional convenience methods including getter methods for the properties in SimpleTag.
since:
   2.0




Constructor Summary
public  SimpleTagSupport()
     Sole constructor.

Method Summary
public  voiddoTag()
     Default processing of the tag does nothing.
throws:
  JspException - Subclasses can throw JspException to indicatean error occurred while processing this tag.
throws:
  javax.servlet.jsp.SkipPageException - If the page that(either directly or indirectly) invoked this tag is tocease evaluation.
final public static  JspTagfindAncestorWithClass(JspTag from, Class klass)
     Find the instance of a given class type that is closest to a given instance. This method uses the getParent method from the Tag and/or SimpleTag interfaces.
protected  JspFragmentgetJspBody()
     Returns the body passed in by the container via setJspBody.
protected  JspContextgetJspContext()
     Returns the page context passed in by the container via setJspContext.
public  JspTaggetParent()
     Returns the parent of this tag, for collaboration purposes.
public  voidsetJspBody(JspFragment jspBody)
     Stores the provided JspFragment.
public  voidsetJspContext(JspContext pc)
     Stores the provided JSP context in the private jspContext field.
public  voidsetParent(JspTag parent)
     Sets the parent of this tag, for collaboration purposes.


Constructor Detail
SimpleTagSupport
public SimpleTagSupport()(Code)
Sole constructor. (For invocation by subclass constructors, typically implicit.)




Method Detail
doTag
public void doTag() throws JspException, IOException(Code)
Default processing of the tag does nothing.
throws:
  JspException - Subclasses can throw JspException to indicatean error occurred while processing this tag.
throws:
  javax.servlet.jsp.SkipPageException - If the page that(either directly or indirectly) invoked this tag is tocease evaluation. A Simple Tag Handler generated from a tag file must throw this exception if an invoked Classic Tag Handler returned SKIP_PAGE or if an invoked SimpleTag Handler threw SkipPageException or if an invoked Jsp Fragmentthrew a SkipPageException.
throws:
  IOException - Subclasses can throw IOException if there wasan error writing to the output stream
See Also:   SimpleTag.doTag



findAncestorWithClass
final public static JspTag findAncestorWithClass(JspTag from, Class klass)(Code)
Find the instance of a given class type that is closest to a given instance. This method uses the getParent method from the Tag and/or SimpleTag interfaces. This method is used for coordination among cooperating tags.

For every instance of TagAdapter encountered while traversing the ancestors, the tag handler returned by TagAdapter.getAdaptee() - instead of the TagAdpater itself - is compared to klass. If the tag handler matches, it - and not its TagAdapter - is returned.

The current version of the specification only provides one formal way of indicating the observable type of a tag handler: its tag handler implementation class, described in the tag-class subelement of the tag element. This is extended in an informal manner by allowing the tag library author to indicate in the description subelement an observable type. The type should be a subtype of the tag handler implementation class or void. This addititional constraint can be exploited by a specialized container that knows about that specific tag library, as in the case of the JSP standard tag library.

When a tag library author provides information on the observable type of a tag handler, client programmatic code should adhere to that constraint. Specifically, the Class passed to findAncestorWithClass should be a subtype of the observable type.
Parameters:
  from - The instance from where to start looking.
Parameters:
  klass - The subclass of JspTag or interface to be matched the nearest ancestor that implements the interfaceor is an instance of the class specified




getJspBody
protected JspFragment getJspBody()(Code)
Returns the body passed in by the container via setJspBody. the fragment encapsulating the body of this tag, ornull if the action element is empty in the page.



getJspContext
protected JspContext getJspContext()(Code)
Returns the page context passed in by the container via setJspContext. the page context for this invocation



getParent
public JspTag getParent()(Code)
Returns the parent of this tag, for collaboration purposes. the parent of this tag



setJspBody
public void setJspBody(JspFragment jspBody)(Code)
Stores the provided JspFragment.
Parameters:
  jspBody - The fragment encapsulating the body of this tag.If the action element is empty in the page, this method is not called at all.
See Also:   SimpleTag.setJspBody



setJspContext
public void setJspContext(JspContext pc)(Code)
Stores the provided JSP context in the private jspContext field. Subclasses can access the JspContext via getJspContext().
Parameters:
  pc - the page context for this invocation
See Also:   SimpleTag.setJspContext



setParent
public void setParent(JspTag parent)(Code)
Sets the parent of this tag, for collaboration purposes.

The container invokes this method only if this tag invocation is nested within another tag invocation.
Parameters:
  parent - the tag that encloses this tag




Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.