 | Uiinfrastructure API Docs | ||
com.plumtree.xpshared.htmlelements Namespace | |||
| Uiinfrastructure API Docs | ||
com.plumtree.xpshared.htmlelements Namespace | |||
| Class | Description |
|---|---|
| CommonHTMLStrings | |
| DisplayOptions | This helper class contains the display options for displaying HTMLElements. These are used throughout the entire HTML tree (usually from HTMLPage down, although sometimes the root of the tree will be another type of HTMLElement). Since the Display Options are set on every HTMLElement, if someone caches an HTMLElement on the session or application, this object will be leaked (retained) until the session or application is cleared. There may also be some multi-threading issues when using a cached HTMLElement for multiple users (the login page Auth Source dropdown is stored on the application), since each user will attempt to set their own Display Options on the cached HTMLElement. |
| HTMLAnchor | This class can be used to display an HTML anchor element. Spec |
| HTMLArea | Use this class to render an html area element. Spec |
| HTMLB | This class can be used to display an HTML b element. |
| HTMLBdo |
Spec |
| HTMLBlockQuote | |
| HTMLBody |
Spec |
| HTMLBr | Use this class to render an html br element. |
| HTMLComment | Use this class to render an html comment. |
| HTMLDiv | This class can be used to display an HTML div element. Spec |
| HTMLElement | All object representing HTML elements should subclass this class. Defined within this abstract class are methods for getting and setting attributes common to all HTML elements, such as ID, NAME, CLASS, and STYLE. Other methods, such as appendInnerHTML and appendTabs, will help subclasses display themselves. Most all of the code for displaying HTML and generating HTML strings is located in this class. For the most part, subclasses will not need to concern themselves with this functionality, but only with implementing the abstract methods of this class. Exceptions to this are those subclasses that need to modify their display in some way, such as the HTMLElementCollection class. This class displays much like any other HTMLElement object, except it does not display any HTML itself, but only that HTML generated by its children. For this reason, the HTMLElementCollection class needs to override the display methods of this class. Other classes may not support HTML formatting, such as the HTMLAnchor and HTMLTextArea class. Formatting of the HTML generated by these classes affects the display in a bad way, so formatting is not supported, and display methods need to be overridden. This class also provides methods and data structures for managing nested HTML objects, such as addInnerHTMLElement and getInnerHTMLElements. |
| HTMLElement.ValidationLevel | |
| HTMLElementCollection | This class can be used to represent HTML elements for which no specific class exists. It is far better thing to use a class specific to the element you wish to render, than to use this class. |
| HTMLEm | |
| HTMLException | |
| HTMLForm | This class can be used to display an HTML form element. Spec |
| HTMLFrame |
Spec |
| HTMLFrameSet |
Spec |
| HTMLGenericElement | This class can be used to represent HTML elements for which no specific class exists. It is far better thing to use a class specific to the element you wish to render, than to use this class. |
| HTMLGenericInputElement | Classes that implement objects that can be used to obtain Strings that will render HTML elements that can be used to send name/value pairs in an HTTP request to a server may extend this abstract class. This class implements some functionality common to all such html elements. |
| HTMLH1 | This class can be used to display an HTML H1 element. Spec |
| HTMLH2 | This class can be used to display an HTML H2 element. Spec |
| HTMLH3 | This class can be used to display an HTML H3 element. Spec |
| HTMLH4 | This class can be used to display an HTML H4 element. Spec |
| HTMLHead | Use this class to render an html head element. Spec |
| HTMLImg | Use this class to render an html img element. Spec |
| HTMLInput | This class can be used to render an html input element. Spec This class extends HTMLGeneralInputElement. This means that objects of this class can be used to set name/value pairs within a form. This class also implements TabableHTMLElement. This means that this class can generate a tabindex property that helps to guide the clients browser as the client tabs through form elements. |
| HTMLInputTypes | This class contains constants identifying the various types of INPUT element. These constants can be used to instantiate HTMLInput type objects. |
| HTMLLayer | This |
| HTMLLink |
Spec |
| HTMLList | Title: HTMLList Description: Copyright: Copyright (c) 2002 Company: Plumtree Software |
| HTMLListItem | Title: HTMLListItem Description: Copyright: Copyright (c) 2002 Company: Plumtree Software |
| HTMLListTypes | Title: HTMLListTypes Description: Copyright: Copyright (c) 2002 Company: Plumtree Software |
| HTMLMap | Use this class to render an html map element. Spec |
| HTMLMeta | See the spec |
| HTMLNoScript | |
| HTMLOption |
Spec |
| HTMLP | This class can be used to display an HTML p element. |
| HTMLPage | This object can display an entire page of HTML, consisting of one <html> element, one <head> element and one <body> element. Use the SetHead() and SetBody() methods to define the contents of this HTML page. Use the validateHTML() method to determine whether or not the html generated by this object complies to the HTML 4 specification. This method requires that CSE HTML Validator 5.0 be installed on the client computer. |
| HTMLQ | |
| HTMLScript |
Spec |
| HTMLScriptCollection | |
| HTMLSelect | This class can be used to obtain a String describing an HTML SELECT element. Spec This class extends HTMLGeneralInputElement. This means that objects of this class can be used to set name/value pairs within an HTML FORM. This class also implements TabableHTMLElement. This means that this class can generate a tabindex property that helps to guide the clients browser as the client tabs through form elements. |
| HTMLSpan | This class can be used to display an HTML span element. Spec |
| HTMLStrong | This class can be used to display an HTML b element. |
| HTMLTable | Use this HTMLElement object to generate an html table tag. Spec |
| HTMLTableCell | Use this object to generate a <td></td> tag. Spec |
| HTMLTableHeader | Use this object to generate a <td></td> tag. Spec |
| HTMLTableRow | |
| HTMLTextArea |
Spec |
| HTMLTitle |
Spec |
| StyleClass | This class represents a style class defined in an HTML style sheet. To use a custom style class, simply create a new StyleClass instance with your custom style and pass it into the HTMLElement. For example, if you have an HTMLTable object, and you wish to set a custom style class, you can do this: myTable.SetStyleClass( new StyleClass("customclass" );
The resulting html will look something like: <table class="customclass"> ... |
| Interface | Description |
|---|---|
| TabableHTMLElement | This interface is implemented by all HTML element-generating classes that generate HTML elements that may contain tab indexes. A tab index is a property that guides the clients browser as the client attempts to tab through form elements. HTML browsers will generally tab to form elements with lower tab indexes before moving on to form elements with higher tab indexes. Form elements with equal tab indexes will generally be tabbed through in the order by which they were sent to the browser. Form elements with tab indexes are generally tabbed through before form elements without tab indexes. Tab indexes are set and returned as simple Java String objects. Classes implementing this interface are responsible for verifying that the passed String does represent a valid tab index, specifically an integer between 0 and some big integer. |