Package org.pajes.html

Provides classes for building the user interface of your application, and returning the formatted, generated HTML documents to the user's browser.

See:
Description

Interface Summary

Constants	Provides a type-safe mechanism for specifying various HTML constants.
HTML	The HTML interface is implemented by all HTML objects.
InputMandatoryValidation	This interface is implemented by all Input objects that require the user to provide input.
InputValidation	This interface is implemented by all HTML objects that require validation of their input.
OptionItem	Marker interface for all items that can be added to a SelectList.
TextContainer	This interface is implemented by all HTML objects that contain text.
Traversable	This interface is implemented by all objects that contain other HTML objects.

Class Summary

Anchor	This class builds the HTML ANCHOR tags (<a></a>) for defining hyper links.
AnchorButton	This class creates button for a form which invokes a URL.
Applet	This class generates the <applet> tags.
Big	Issues the Big tags around a piece of text or HTML.
Body	This class builds the BODY tag and all of the HTML objects that appear between the >body< and >/body< tags.
Bold	Issues the Bold tags around a piece of text or HTML.
Break	Creates a line break <br> tag
Button	This class creates an INPUT button for a form.
Center	This class generates the CENTER tags.
Cite	Issues the Citation tags around a piece of text or HTML.
Code	Issues the Code tags around a piece of text or HTML.
Color	Utility class for specifying HTML colours.
Container	The base class for all HTML objects that contain other HTML objects.
Dfn	Issues the DefiningInstance tags around a piece of text or HTML.
Div	This class generates the DIV tags.
DocType	Represents a Document Type Declaration.
Em	Issues the Emphasize tags around a piece of text or HTML.
FileUploadForm	Container class for form elements that include a file upload component.
Font	Issues the Font tags around a piece of text or HTML.
Form	Container class for form elements
FormattedText	Formats a piece of text or HTML with the following content and/or physical style tags: <cite> <code> <defn> <em> <kbd> <samp> <strong> <var> <b> <big> <i> <small> <strike> <sub> <sup> <tt> <u> <font>
Frame	Generates <frame> tags.
FrameSet	This class generates the frameset tags.
Head	Generates the >HEAD< and >/HEAD< tags and hold all the HTML objects that appear between them.
Heading	Places the heading tags around a piece of text or HTML.
HorizontalLine	Generates <hr> tags.
IFrame	Generates <iframe> inline frame tags.
Image	Generates the <ing> tag to display a graphical element.
Input	Base Class for all form input elements.
InputCheckBox	This class builds the HTML checkbox tag.
InputChecked	Super-class of Input elements that have only an on/off state.
InputDate	This class creates an input field in a form that accepts a date value from the user.
InputDateIcon	This class returns the default icon for the InputDate pop-up calendar.
InputDateStyleSheet	This class returns the default style sheet for the InputDate pop-up calendar.
InputDateTimeString	This class creates an input field in a form that accepts a a formatted string from the user.
InputDecimal	This class creates an input field in a form that accepts an decimal value from the user.
InputField	This class is the base class for all the form input elements that have a text box for entry.
InputFile	This class creates an input field in a form that accepts a file from the user.
InputFormattedString	This class creates an input field in a form that accepts a a formatted string from the user.
InputHidden	This class is a client side hidden variable on a form.
InputInteger	This class creates an input field in a form that accepts an integer value from the user.
InputNumber	This class creates an input field in a form that accepts a numeric value from the user.
InputPassword	This class creates an input field in a form that accepts a password from the user.
InputPasswordConfirm	This class creates an input field in a form that is used to confirm a password entered into an associated password field.
InputRadio	This class builds the HTML radio button tag.
InputRadioButtonSet	This class builds a set of HTML radio button tags.
InputString	This class creates an input field in a form that accepts a string from the user.
InputTextArea	This class creates an multi-line input text area in a form.
InputTime	This class creates an input field in a form that accepts a timestamp (date and time values) from the user.
InputTimestamp	This class creates an input field in a form that accepts a timestamp (date and time values) from the user.
Italic	Issues the Italic tags around a piece of text or HTML.
Kbd	Issues the Keyboard tags around a piece of text or HTML.
Label	This class builds the HTML LABEL tags (<label></label>) for annotating input tags.
ListContainer	Super-class of all list containers.
ListItem	Creates a List Item that appears in an Ordered or Unordered List
NoBreak	This class generates the <NOBR> tags.
NoFrames	This class generates the NOFRAMES tags.
NoScript	This class generates the NOSCRIPT tags.
Option	Generate the <option> tags to create list boxes and drop-down lists.
OptionGroup	Generate the <OPTGROUP> tags to create list boxes and drop-down lists.
OrderedList	Creates an HTML Ordered List
Paje	Container to hold all the objects within the <HTML> and </HTML> tags.
PajeFactory	Combines a PajeTemplate with one or more source HTML files.
PajeMemoryManager	The PajeMemoryManager is responsible for destroying Paje instances after they have been finished with, and can also intermittently suggest that the garbage collector should run.
PajeParser	The PajeParser class takes an input stream and parses it into "tokens", allowing the tokens to be read one at a time.
PajeResource	A PajeResource identifies a collection of resources within a ServletContext that are mapped to a path that contains a variable component.
PajeTemplate	Generates an Paje instance from a source HTML file.
PajeTemplateWarning	Handles warnings generated by PajeTemplate when parsing a source HTML file.
Paragraph	This class generates the <P> tags.
Parameter	Generate the <param> tags for <applet> and <object> tags.
PlainText	This class emits the text that is used within containers such as Script and StyleSheet, where no substitution of character entities should be performed.
PreFormatted	Issues the PRE tags around a piece of text or HTML.
ResetButton	This class creates a Reset button on the form
Samp	Issues the Sample tags around a piece of text or HTML.
Script	This class generates the tags to send JavaScript to the client.
Select	Abstract class to generate the <SELECT> and associated <OPTION> tags to create list boxes and drop-down lists.
SelectJavaScriptList	Generates the <SELECT>, and the associated <OPTION> tags to create list boxes and drop-down lists are generated from a client-side JavaScript script.
SelectList	Generates the <SELECT> and associated <OPTION> tags to create list boxes and drop-down lists.
SingleElementContainer	Creates a container that contains only one other element.
Small	Issues the Small tags around a piece of text or HTML.
Span	Generate the <span> tags.
Strike	Issues the Strike tags around a piece of text or HTML.
Strong	Issues the Strong tags around a piece of text or HTML.
StyleSheet	This class builds the STYLE tag and all of the Style Attributes that appear between the STYLE and /STYLE tags
Submit	This abstract class is extended by classes that provide the ability to select an HTML element on a form that will submit the contents of the form for processing.
SubmitAnchor	This class builds an HTML ANCHOR tag (<A></A>) that can submit a form or act as a standard hyper-link.
SubmitButton	This class creates a Submit button on the form.
SubmitImage	This class creates a Submit image on the form.
Subscript	Issues the Subscript tags around a piece of text or HTML.
Superscript	Issues the Superscript tags around a piece of text or HTML.
Table	This class generates the TABLE and /TABLE tags.
TableContainer	This class provides the common methods for the Table object and all its inner classes.
Tag	Base Class for all HTML generation classes.
TagAttribute	Represents a single tag attribute.
Teletype	Issues the Teletype tags around a piece of text or HTML.
Text	This class emits the text that is to be displayed in the browser.
TraversableElement	This abstract class is extended by all objects that contain other HTML objects.
Underline	Issues the Underline tags around a piece of text or HTML.
UnOrderedList	Creates an HTML Unordered List
Var	Issues the Variable tags around a piece of text or HTML.

Exception Summary

FieldNotFoundException	Thrown when a TraversableElement.getFieldByName(java.lang.String) search fails to locate the requested field.
PajeParserException	Thrown when an exception is detected parsing an HTML template.
TagException	Thrown when a run-time exception relating to the construction of an HTML tag occurs.
TagNotFoundException	Thrown when a TraversableElement.getTagByID(java.lang.String) search fails to locate the requested HTML element.

Package org.pajes.html Description

Provides classes for building the user interface of your application, and returning the formatted, generated HTML documents to the user's browser.

Client-Side JavaScript Form Validation

The Input object and its sub-classes provide transparent validation of input using the classes found in the org.pajes.html.validation package.

HTML Templates

HTML documents may also be built from template HTML source files, and converted to Paje instances, using PajeFactory, PajeTemplate, and PajeResource.

PajeFactory supports automatic detection and return of an appropriate Internationalized HTML document, if one exists, and the automatic detection of source file changes.

PajeResource allows a collection of related HTML documents to be accessed by one factory, returning the correct (and also possibly internationalised) document based on some variable key (such as a customer code).

Security

All of the HTML implementations in this package inherit the HTML.setWritePermission(org.pajes.security.WritePermission, java.lang.String, java.lang.String) method. This allows an implementation of the WritePermission interface to be specified that will determine at run time whether a particular element of the page should be displayed back to the browser. This facility allows, for example, a security system based on only showing menu options to which a user has access. By default, all classes use the DefaultWritePermission Singleton instance to always allow every element to be returned.