Java Doc for SharedTag.java in  » Search-Engine » regain » net » sf » regain » util » sharedtag » Java Source Code / Java DocumentationJava Source Code and Java Documentation

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 geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Search Engine » regain » net.sf.regain.util.sharedtag 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   net.sf.regain.util.sharedtag.SharedTag

All known Subclasses:   net.sf.regain.search.sharedlib.ListTag,  net.sf.regain.ui.desktop.status.sharedlib.autoupdate.MetaTag,  net.sf.regain.search.sharedlib.input.QueryTag,  net.sf.regain.search.sharedlib.input.SubmitTag,  net.sf.regain.search.sharedlib.stats.QueryTag,  net.sf.regain.ui.desktop.config.sharedlib.FormTag,  net.sf.regain.search.sharedlib.ParamTag,  net.sf.regain.search.sharedlib.error.AbstractErrorTag,  net.sf.regain.ui.desktop.status.sharedlib.autoupdate.FormTag,  net.sf.regain.ui.desktop.status.sharedlib.IndexupdateTag,  net.sf.regain.search.sharedlib.stats.FromTag,  net.sf.regain.search.sharedlib.hit.AbstractHitTag,  net.sf.regain.search.sharedlib.input.FieldlistTag,  net.sf.regain.search.sharedlib.MsgTag,  net.sf.regain.search.sharedlib.CheckTag,  net.sf.regain.search.sharedlib.stats.SearchtimeTag,  net.sf.regain.search.sharedlib.input.HiddenparamTag,  net.sf.regain.ui.desktop.config.sharedlib.EditlistTag,  net.sf.regain.search.sharedlib.stats.ToTag,  net.sf.regain.ui.desktop.status.sharedlib.CurrentindexTag,  net.sf.regain.search.sharedlib.hit.ScoreTag,  net.sf.regain.ui.desktop.config.sharedlib.TextTag,  net.sf.regain.ui.desktop.status.sharedlib.IndexupdatecontrolTag,  net.sf.regain.ui.desktop.status.sharedlib.LogTag,  net.sf.regain.search.sharedlib.input.MaxresultsTag,  net.sf.regain.search.sharedlib.NavigationTag,  net.sf.regain.search.sharedlib.stats.TotalTag,  net.sf.regain.ui.desktop.status.sharedlib.ProfilerTag,  net.sf.regain.ui.desktop.config.sharedlib.IntervalTag,
SharedTag
abstract public class SharedTag (Code)
A tag that may be used within the taglib technology or the simpleweb technology.
author:
   Til Schneider, www.murfman.de


Field Summary
final public static  intEVAL_TAG_BODY
     Specifies that the tag body should be evaluated.
final public static  intSKIP_TAG_BODY
     Specifies that the tag body should be skipped.

Constructor Summary
public  SharedTag()
     Creates a new instance of SharedTag.

Method Summary
protected  LocalizergetLocalizer()
     Gets the localizer.
public  StringgetParameter(String name)
     Gets a parameter.
Parameters:
  name - The parameter's name.
public  StringgetParameter(String name, String defaultValue)
     Gets a parameter.
Parameters:
  name - The parameter's name.
Parameters:
  defaultValue - The value to return if the parameter was not set.
public  StringgetParameter(String name, boolean mandatory)
     Gets a parameter.
Parameters:
  name - The parameter's name.
Parameters:
  mandatory - Specifies whether the parameter is mandatory.
public  booleangetParameterAsBoolean(String name, boolean defaultValue)
     Gets a parameter and converts it to a boolean.
Parameters:
  name - The name of the parameter.
Parameters:
  defaultValue - The value to return if the parameter is not set.
throws:
  RegainException - When the parameter value is not a number.
public  intgetParameterAsInt(String name, int defaultValue)
     Gets a parameter and converts it to an int.
Parameters:
  name - The name of the parameter.
Parameters:
  defaultValue - The value to return if the parameter is not set.
throws:
  RegainException - When the parameter value is not a number.
public  StringgetTagName()
     Gets the name of this Tag.

The name of the tag is extracted from the class name.

public  intprintAfterBody(PageRequest request, PageResponse response)
     Called after the body content was evaluated.
Parameters:
  request - The page request.
Parameters:
  response - The page response.
public  voidprintEndTag(PageRequest request, PageResponse response)
     Called when the parser reaches the end tag.
public  intprintStartTag(PageRequest request, PageResponse response)
     Called when the parser reaches the start tag.
Parameters:
  request - The page request.
Parameters:
  response - The page response.
final public  voidsetContext(PageRequest request)
     Sets the tag execution context.
public  voidsetParameter(String name, String value)
     Sets a parameter.
public  StringtoString()
     Gets the String representation of this tag.
final public  voidunsetContext()
     Unsets the tag execution context.

Field Detail
EVAL_TAG_BODY
final public static int EVAL_TAG_BODY(Code)
Specifies that the tag body should be evaluated.



SKIP_TAG_BODY
final public static int SKIP_TAG_BODY(Code)
Specifies that the tag body should be skipped.




Constructor Detail
SharedTag
public SharedTag()(Code)
Creates a new instance of SharedTag.




Method Detail
getLocalizer
protected Localizer getLocalizer()(Code)
Gets the localizer.

Note: The localizer is only not null, when the tag is currently executed. Which is in the SharedTag.printStartTag(PageRequest,PageResponse) , the SharedTag.printAfterBody(PageRequest,PageResponse) ant the SharedTag.printEndTag(PageRequest,PageResponse) . The localizer.




getParameter
public String getParameter(String name)(Code)
Gets a parameter.
Parameters:
  name - The parameter's name. The value of the parameter or null if the parameterwas not set.



getParameter
public String getParameter(String name, String defaultValue)(Code)
Gets a parameter.
Parameters:
  name - The parameter's name.
Parameters:
  defaultValue - The value to return if the parameter was not set. The value of the parameter or the default value if the parameterwas not set.



getParameter
public String getParameter(String name, boolean mandatory) throws RegainException(Code)
Gets a parameter.
Parameters:
  name - The parameter's name.
Parameters:
  mandatory - Specifies whether the parameter is mandatory. The parameter value or null if no such parameter wasgiven and mandatory is false.
throws:
  RegainException - If mandatory is true and the parameterwas not specified.



getParameterAsBoolean
public boolean getParameterAsBoolean(String name, boolean defaultValue) throws RegainException(Code)
Gets a parameter and converts it to a boolean.
Parameters:
  name - The name of the parameter.
Parameters:
  defaultValue - The value to return if the parameter is not set.
throws:
  RegainException - When the parameter value is not a number. The int value of the parameter.



getParameterAsInt
public int getParameterAsInt(String name, int defaultValue) throws RegainException(Code)
Gets a parameter and converts it to an int.
Parameters:
  name - The name of the parameter.
Parameters:
  defaultValue - The value to return if the parameter is not set.
throws:
  RegainException - When the parameter value is not a number. The int value of the parameter.



getTagName
public String getTagName()(Code)
Gets the name of this Tag.

The name of the tag is extracted from the class name. In order to work, subclasses must be named using the pattern [TagName]Tag (e.g. NavigationTag for the tag navigation). The name of this tag.




printAfterBody
public int printAfterBody(PageRequest request, PageResponse response) throws RegainException(Code)
Called after the body content was evaluated.
Parameters:
  request - The page request.
Parameters:
  response - The page response. SharedTag.EVAL_TAG_BODY if you want the tag body to be evaluatedonce again or SharedTag.SKIP_TAG_BODY if you want to print theend tag.
throws:
  RegainException - If there was an exception.



printEndTag
public void printEndTag(PageRequest request, PageResponse response) throws RegainException(Code)
Called when the parser reaches the end tag.
Parameters:
  request - The page request.
Parameters:
  response - The page response.
throws:
  RegainException - If there was an exception.



printStartTag
public int printStartTag(PageRequest request, PageResponse response) throws RegainException(Code)
Called when the parser reaches the start tag.
Parameters:
  request - The page request.
Parameters:
  response - The page response. SharedTag.EVAL_TAG_BODY if you want the tag body to be evaluated orSharedTag.SKIP_TAG_BODY if you want the tag body to be skipped.
throws:
  RegainException - If there was an exception.



setContext
final public void setContext(PageRequest request) throws RegainException(Code)
Sets the tag execution context.

Is called by the shared tag engine before the start tag is processed.
Parameters:
  request - The request to get the context from
throws:
  RegainException - If setting the context failed.




setParameter
public void setParameter(String name, String value)(Code)
Sets a parameter.
Parameters:
  name - The parameter's name.
Parameters:
  value - The parameter's value.



toString
public String toString()(Code)
Gets the String representation of this tag. The String representation.



unsetContext
final public void unsetContext()(Code)
Unsets the tag execution context.

Is called by the shared tag engine after the end tag was processed.




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.