| javax.servlet.jsp.tagext.BodyTagSupport
 org.apache.beehive.netui.tags.AbstractClassicTag
All known Subclasses: org.apache.beehive.netui.tags.databinding.repeater.Repeater, org.apache.beehive.netui.tags.databinding.invoke.AbstractCallMethod, org.apache.beehive.netui.tags.html.HtmlBaseTag, org.apache.beehive.netui.tags.databinding.cellrepeater.CellRepeater, org.apache.beehive.netui.tags.databinding.invoke.MethodParameter, org.apache.beehive.netui.tags.databinding.message.Message, org.apache.beehive.netui.tags.html.RewriteName, org.apache.beehive.netui.tags.template.SetAttribute, org.apache.beehive.netui.tags.databinding.message.MessageArg, org.apache.beehive.netui.tags.template.Template, org.apache.beehive.netui.tags.javascript.ScriptHeader, org.apache.beehive.netui.tags.html.ConfigurePopup, org.apache.beehive.netui.tags.html.HtmlGroupBaseTag, org.apache.beehive.netui.tags.databinding.script.GetData, org.apache.beehive.netui.tags.databinding.bundle.DeclareBundle, org.apache.beehive.netui.tags.databinding.xml.SerializeXML, org.apache.beehive.netui.tags.template.Section, org.apache.beehive.netui.tags.html.ParameterMap, org.apache.beehive.netui.tags.html.Parameter, org.apache.beehive.netui.tags.html.RetrievePopupOutput, org.apache.beehive.netui.tags.html.RewriteURL, org.apache.beehive.netui.tags.template.IncludeSection, org.apache.beehive.netui.tags.divpanel.DivPanel, org.apache.beehive.netui.tags.databinding.repeater.RepeaterComponent, org.apache.beehive.netui.tags.javascript.ScriptContainer,
| AbstractClassicTag | | abstract public class AbstractClassicTag extends BodyTagSupport implements INetuiTag(Code) | | AbstractBaseTag is the base tag for most of the NetUI tags. This tag provides default behavior
and services for NetUI tags. There following categories of services are provided by this tag:
- Generic Services -- These are general services such as access to local, writting
to the response, and writting attributes.
- Expression Management -- This set of method provide evaluation and information about
expressions. These methods allow tags to fully support expressions for attributes.
- Naming and NamingInterceptor Services -- This set of methods will apply
INameInterceptors to a name to produce the name written out. In addition, it allows
the URL Rewritter service to modify names.
- Attribute Rendering Support -- This set of routine allow tags to keep simple attributes
in a map that can be written into the generated markup. There are two types of attributes, attributes
that contain expression and attributes that do not contain expression supported.
- Error Reporting -- This set of routines will report errors within the tags. In development
mode errors are reported in-page.
- JavaScript Services -- This set of routines provide simple access for JavaScript generation.
|
| Field Summary | |
| final public static List | DefaultNamingChain
This List represents the default naming chain for handling dataSource attributes. | | final protected static String | EMPTY_STRING
String constant for the empty string. | | final public static String | NETUI_UNIQUE_CNT
This is the name of a request scoped attribute which creates a unique id for processing
a request. |
| Method Summary | |
| protected String | applyNamingChain(String name)
This method walks all of the naming chains and allows them to rewrite the name parameter.
After the naming chain processes the name, it will be passed to rewriteName for final processing.
If the naming chaing returned from getNamingChain returns null, the name will be passed to
rewriteName and returned. | | protected String | getErrorsReport()
This method will return a String that represents all of the errors that were
registered for the tag. | | final protected String | getIdForTagId(String tagId)
This method will generate a real id based upon the passed in tagId. | | protected List | getNamingChain()
Return an List which represents a chain of INameInterceptor
objects. | | protected Form | getNearestForm()
Returns the closest parent form tag, or null if there is none. | | protected int | getNextId(ServletRequest req)
This method will generate the next unique int within the HTML tag. | | protected IScriptReporter | getScriptReporter()
Return the closest ScriptReporter in the parental chain. | | abstract public String | getTagName()
Return the name of the tag. | | protected Locale | getUserLocale()
This method will return the user local of the request. | | protected boolean | hasErrors()
This method will return true if there have been any errors registered on this
tag. | | protected void | localRelease()
This is a method that will reinitialize all temporary state on a
tag and should be called in the doEndTag method. | | protected String | qualifyAttribute(String name)
An internal method that allows a tag to qualify the name paramater by converting
it from a struts style naming convention to an explicit databinding expression. | | public void | registerTagError(String message, Throwable e)
This will report an error from a tag. | | public void | registerTagError(AbstractPageError error)
This will report an error from a tag. | | protected int | reportAndExit(int returnValue)
This is a simple routine which will call the error reporter if there is an
error and then call local release before returning the returnValue.
This is a very common code sequence in the Classic Tags so we provide this routine.
Parameters:
returnValue - The value that will be returned. | | protected void | reportErrors()
This method will write out the String returned by getErrorsReport to the
response output stream. | | final protected String | rewriteName(String name)
This method will rewrite the name (id) by passing it to the
URL Rewritter and getting back a value. | | final protected String | setNonEmptyValueAttribute(String attrValue)
Filter out the empty string value and return either the value or null. | | final protected String | setRequiredValueAttribute(String attrValue, String attrName)
Report an error if the value of attrValue is equal to the empty string, otherwise return
that value. | | final protected void | write(String string)
This mehod will write the passed string to the response. |
| DefaultNamingChain | | final public static List DefaultNamingChain(Code) | | This List represents the default naming chain for handling dataSource attributes. The list
is a read-only list which may be used by any dataSource implementation.
|
| EMPTY_STRING | | final protected static String EMPTY_STRING(Code) | | String constant for the empty string.
|
| NETUI_UNIQUE_CNT | | final public static String NETUI_UNIQUE_CNT(Code) | | This is the name of a request scoped attribute which creates a unique id for processing
a request.
|
| applyNamingChain | | protected String applyNamingChain(String name) throws JspException(Code) | | This method walks all of the naming chains and allows them to rewrite the name parameter.
After the naming chain processes the name, it will be passed to rewriteName for final processing.
If the naming chaing returned from getNamingChain returns null, the name will be passed to
rewriteName and returned. If there is an ExpressionEvaluationException thrown
by a INameInterceptor, the error will be registered with the tag and null will
be returned.
Parameters:
name - the name to rewrite the name after it was passed to all INameInterceptors in the naming chain.
See Also: AbstractClassicTag.rewriteName
See Also: org.apache.beehive.netui.tags.naming.INameInterceptor |
| getErrorsReport | | protected String getErrorsReport()(Code) | | This method will return a String that represents all of the errors that were
registered for the tag. This method assumes that there are errors in the tag and asserts
this is true. Code will typically call hasErrors before calling this method.
A String that contains all of the errors registered on this tag. |
| getIdForTagId | | final protected String getIdForTagId(String tagId)(Code) | | This method will generate a real id based upon the passed in tagId. The generated
id will be constucted by searching upward for all the script containers that have a
scope id set. These will form a fully qualified id.
Parameters:
tagId - The base tagId set on a tag an id value formed by considering all of the scope id's found in the tag hierarchy. |
| getNamingChain | | protected List getNamingChain()(Code) | | Return an List which represents a chain of INameInterceptor
objects. This method by default returns null and should be overridden
by objects that support naming.
an List that will contain INameInterceptor objects. |
| getNearestForm | | protected Form getNearestForm()(Code) | | Returns the closest parent form tag, or null if there is none.
|
| getNextId | | protected int getNextId(ServletRequest req)(Code) | | This method will generate the next unique int within the HTML tag.
Parameters:
req - the Request the next unique integer for this request. |
| getScriptReporter | | protected IScriptReporter getScriptReporter()(Code) | | Return the closest ScriptReporter in the parental chain. Searching starts
at this node an moves upward through the parental chain.
a ScriptReporter or null if there is not one found. |
| getTagName | | abstract public String getTagName()(Code) | | Return the name of the tag. Used by error reporting to get the name of the tag.
the name of the tag. |
| getUserLocale | | protected Locale getUserLocale()(Code) | | This method will return the user local of the request.
the Locale object to use when rendering this tag |
| hasErrors | | protected boolean hasErrors()(Code) | | This method will return true if there have been any errors registered on this
tag. Otherwise it returns false
true if errors have been reported on this tag. |
| localRelease | | protected void localRelease()(Code) | | This is a method that will reinitialize all temporary state on a
tag and should be called in the doEndTag method.
|
| qualifyAttribute | | protected String qualifyAttribute(String name) throws JspException(Code) | | An internal method that allows a tag to qualify the name paramater by converting
it from a struts style naming convention to an explicit databinding expression. The qualified
name will be returned. This method may report an error if there is an error in the expression.
Parameters:
name - the name to be qualified the name which has been qualified
throws:
JspException - throws a JspException if in-page error reporting is turned off.
See Also: org.apache.beehive.netui.tags.naming.FormDataNameInterceptor |
| registerTagError | | public void registerTagError(String message, Throwable e) throws JspException(Code) | | This will report an error from a tag. The error will
contain a message. If error reporting is turned off,
the message will be returned and the caller should throw
a JspException to report the error.
Parameters:
message - - the message to register with the error
throws:
JspException - - if in-page error reporting is turned off this method will alwaysthrow a JspException. |
| registerTagError | | public void registerTagError(AbstractPageError error) throws JspException(Code) | | This will report an error from a tag. The error must
be be an AbstractPageError.
Parameters:
error - The AbstractPageError to add to the error list.
throws:
JspException - - if in-page error reporting is turned off this method will alwaysthrow a JspException. |
| reportAndExit | | protected int reportAndExit(int returnValue) throws JspException(Code) | | This is a simple routine which will call the error reporter if there is an
error and then call local release before returning the returnValue.
This is a very common code sequence in the Classic Tags so we provide this routine.
Parameters:
returnValue - The value that will be returned. returnValue is always returned.
throws:
JspException - |
| rewriteName | | final protected String rewriteName(String name)(Code) | | This method will rewrite the name (id) by passing it to the
URL Rewritter and getting back a value.
Parameters:
name - the name that will be rewritten a name that has been rewritten by the URLRewriterService. |
| setNonEmptyValueAttribute | | final protected String setNonEmptyValueAttribute(String attrValue)(Code) | | Filter out the empty string value and return either the value or null. When the value of
attrValue is equal to the empty string this will return null, otherwise it will
return the value of attrValue.
Parameters:
attrValue - This is the value we will check for the empty string. either the value of attrValue or null |
| setRequiredValueAttribute | | final protected String setRequiredValueAttribute(String attrValue, String attrName) throws JspException(Code) | | Report an error if the value of attrValue is equal to the empty string, otherwise return
that value. If attrValue is equal to the empty string, an error is registered and
null is returned.
Parameters:
attrValue - The value to be checked for the empty string
Parameters:
attrName - The name of the attribute either the attrValue if it is not the empty string or null
throws:
JspException - A JspException will be thrown if inline error reporting is turned off. |
| write | | final protected void write(String string)(Code) | | This mehod will write the passed string to the response.
Parameters:
string - to be written to the response. |
|
|