Uiinfrastructure API Docs  
 

HTMLScriptCollection Members

HTMLScriptCollection overview

Public Instance Constructors

HTMLScriptCollection Constructor Creates a new HTMLScriptCollection object.

Public Instance Fields

bForceFormattingOff (inherited from HTMLElement) Set this boolean true to force formatting of for this element as well as nested elements.
bForceFormattingOn (inherited from HTMLElement) 

Public Instance Methods

AddInnerHTMLElement HTMLElement.addInnerHTMLElement rewritten.
AddInnerHTMLEncodedString (inherited from HTMLElement) Call this method to append an additional HTML String to be displayed within this HTML element. For example, if this is a <body> element, and you append the "<img>" String, and then you append the "<a>" String, the body element will display something like: "<body><img><a></body>"

Not all HTML elements allow you to append inner HTML Strings. Such elements will throw an exception if you attempt to do this.

The String appended is not validated. You are free to append garbage. This String will be automatically HTMLEncoded for you. This method will be significantly slower than addInnerHTMLString(), so it should only be used for data that really needs to be HTMLEncoded (things entered by users). This method should not be used for localized strings, which should be safe. If a string contains some text that should be encoded, and some that should not, it should be manually encoded and addInnerHTMLString() should be used.
AddInnerHTMLString This method rewritten to prevent usage.
CleanupHTMLSubtreeAfterRendering (inherited from HTMLElement) This is only called if this element is the root of the display tree.
ClearInnerHTMLElements (inherited from HTMLElement) Call this method to remove all nested html elements from this element.
Clone (inherited from HTMLElement) Do not call this method. This is implemented only so that internal clone methods can call clone() on HTMLElement objects.
Display (inherited from HTMLElement)Overloaded. Call this method to display this object's HTML to an IXPResponse object.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
ForceFormattingOff (inherited from HTMLElement) Call this method to force formatting off for this HTMLElement object.

Whether or not HTML is formatted generally percolates down through an HTMLElement structure.
GetClone (inherited from HTMLElement) Call this method to obtain a clone of this HTMLElement object.
GetDisabled (inherited from HTMLElement) Call this method to determine whether or not the disabled attribute is displayed for this HTML element.
GetDisplayDidPause (inherited from HTMLElement) Call this method to determine whether or not the most recent call to one of the display methods paused. If this method returns true, a display method must be called again to render a complete HTML page.
GetDisplayString (inherited from HTMLElement)Overloaded. Call this method to obtain a String of HTML markup that represents this HTML element, and all HTML elements nested within.
GetDo508Checking (inherited from HTMLElement) This method returns whether or not to do 508 validity checking for HTMLElements. If this is true, HTMLElements will try to enforce that the developer does not make HTML that is not 508 compliant.
GetDoFormat (inherited from HTMLElement) Call this method to determine whether or not this HTML element generates HTML text formatted for readabilty.
GetElementName (inherited from HTMLElement) Call this method to determine the name of this element.
GetForceLineBreaksAfterSafeElements (inherited from HTMLElement) This method returns whether or not to use line breaks after elements where it does not affect the HTML output.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetID (inherited from HTMLElement) Call this method to determine the value of the id attribute of this HTML element.
GetImgBaseUrl (inherited from HTMLElement) Call this method to obtain the base url used for all HTMLImg objects being displayed
GetInnerHTML (inherited from HTMLElement)Overloaded. Call this method to obtain the HTML nested within this element. This HTML does not contain the HTML for this element.
GetInnerHTMLDisplayString (inherited from HTMLElement) 
GetInnerHTMLElements (inherited from HTMLElement) Call this method to obtain an enumeration of the HTMLElement objects nested within this HTMLElement.

GetInnerHTMLElementsAsArrayList (inherited from HTMLElement) Call this method to get an XPArrayList containing all nested HTMLElement objects.
GetIsNetscape (inherited from HTMLElement) This method returns whether or not the browser is Netscape.
GetLang (inherited from HTMLElement) Returns the language for use in the attribute, either the local language if available, or the global language.
GetName (inherited from HTMLElement) Call this method to determine the value of the name attribute of this HTML element.
GetOnClick (inherited from HTMLElement) Call this method to obtain the value of the setonclick attribute.
GetOnKeyDown (inherited from HTMLElement) Call this method to obtain the value of the onkeydown attribute.
GetOnKeyPress (inherited from HTMLElement) Call this method to obtain the value of the onkeypress attribute.
GetOnKeyUp (inherited from HTMLElement) Call this method to obtain the value of the onkeyup attribute.
GetOnMouseOut (inherited from HTMLElement) Call this method to obtain the value of the onmouseout attribute.
GetOnMouseOver (inherited from HTMLElement) Call this method to obtain the value of the onmouseover attribute.
GetPauseAfterDisplay (inherited from HTMLElement) Call this method to determine whether or not this element pauses after display.
GetPostComment (inherited from HTMLElement) Call this method to obtain the comment that is written after the closing tag of this element.
GetPreComment (inherited from HTMLElement) Call this method to obtain the comment that is written before the opening tag of this element.
GetStyle (inherited from HTMLElement) Call this method to obtain the value of the style attribute of this HTML element.
GetStyleClass (inherited from HTMLElement) Call this method to determine the style class assigned to this HTML element. This style class will be rendered as an attribute of this element, like: <a class="styleclass"...
GetStyleClassPrefix (inherited from HTMLElement) This method returns the style class prefix used for all HTMLElement objects being displayed.
GetTitle (inherited from HTMLElement) 
GetType (inherited from Object)Gets the Type of the current instance.
InsertInnerHTMLElement (inherited from HTMLElement) Adds an innerHTMLElement to the specified element, while also returning the element added.
SaveToTempFile (inherited from HTMLElement)Overloaded. This method saves the display string of this object to a temporary file.

SetDisabled (inherited from HTMLElement) Call this method to toggle the "disabled" attribute for this element.
SetDo508Checking (inherited from HTMLElement) This method sets whether or not to do 508 validity checking for HTMLElements. If this is true, HTMLElements will try to enforce that the developer does not make HTML that is not 508 compliant. This can only be used on a top-level HTMLElement (usually an HTMLPage).
SetDoFormat (inherited from HTMLElement) Call this method to specify whether or not this HTML element generates HTML text formatted for readabilty.
SetElementName (inherited from HTMLElement) Call this method to give this element a name. The name does not affect the HTML output of this element, the name is purely for identification puposes.
SetFlushAfterDisplay (inherited from HTMLElement) Call this method to cause the IXPResponse.Flush() method to be called after this element displays itself. This will only cause a flushing of the response buffer if the IXPResponse object is passed to the display method.
SetForceLineBreaksAfterSafeElements (inherited from HTMLElement) This method controls whether or not to use line breaks after elements where it does not affect the HTML output. This can only be used on a top-level HTMLElement (usually an HTMLPage).
SetID (inherited from HTMLElement) Call this method to set the ID attribute for this HTML element.

ID attributes may not contain spaces or dollar signs or anything weird. ID attributes must be unique to each element on a given HTML page. This is currently not enforced by this method.
SetImgBaseUrl (inherited from HTMLElement) Call this method to set the base url used for all HTMLImg objects being displayed.

Call this method only on the root HTMLElement object. If you are building an HTMLPage, for example, call myPage.SetImgBaseUrl( "http://blah/" );. All nested HTMLImg objects may use the base url specified on the HTMLPage object.

HTMLImg objects may or may not use this base url specified. This can only be used on a top-level HTMLElement (usually an HTMLPage).
SetIsNetscape (inherited from HTMLElement) This method sets whether or not the browser is Netscape. Certain HTMLElements will display differently on Netscape versus other browsers. This can only be used on a top-level HTMLElement (usually an HTMLPage).
SetLangGlobal (inherited from HTMLElement) Set the default language available for all child elements -- not necessarily displayed unless the element is set to display the language attribute.
SetLangLocal (inherited from HTMLElement) Sets the value of the language attribute used by this element not the parent or child element(s).
SetName This method rewritten to prevent usage.
SetOnClick This method rewritten to prevent usage.
SetOnKeyDown This method rewritten to prevent usage.
SetOnKeyPress This method rewritten to prevent usage.
SetOnKeyUp (inherited from HTMLElement) Call this method to set the onkeyup attribute
SetOnMouseOut This method rewritten to prevent usage.
SetOnMouseOver This method rewritten to prevent usage.
SetPauseAfterDisplay (inherited from HTMLElement) Call this method to specify whether or not this element pauses after display. If you pass true, after this html element fully renders, display will stop. The resulting HTML will not be complete. One of the display methods must be called again, and rendering will resume with the html immediately after this element. Call GetDisplayPaused() to determine whether or not the previous call to one of the display methods resulted in a pause.
SetPostComment (inherited from HTMLElement) Use this method to set a comment that will be written after the closing tag of this element.
SetPreComment (inherited from HTMLElement) Use this method to set a comment that will be written before the opening tag of this element.
SetStyle This method rewritten to prevent usage.
SetStyleClassOverloaded. This method rewritten to prevent usage.
SetStyleClass (inherited from HTMLElement)Overloaded. Call this method to Set the style class for this HTML element. Calling this method with the parameter "gContentSection", for example, will cause this element to display something like: <td class="gContentSection"...
SetStyleClassPrefix (inherited from HTMLElement) Call this method to set the prefix used for all HTMLElement objects being displayed.

Call this method only on the root HTMLElement object. If you are building an HTMLPage, for example, call myPage.SetStyleClassPrefix( "PREFIX" );. All nested objects may use the prefix specified on the HTMLPage object.

This can only be used on a top-level HTMLElement (usually an HTMLPage).
SetTitle (inherited from HTMLElement) 
ToString (inherited from Object)Returns a String that represents the current Object.

Protected Instance Fields

bDisplayDidPause (inherited from HTMLElement) 
bPauseAfterDisplay (inherited from HTMLElement) 
bResumingAndChildFinished (inherited from HTMLElement) 
bResumingAndChildInMidRender (inherited from HTMLElement) 
bShowLang (inherited from HTMLElement) 
sLangLocal (inherited from HTMLElement) sLangLocal is used when an element's lang attribute is different from the global lang attribute. For example a search result page may display results in languages different from the page itself.

Protected Instance Methods

AppendBeginningOfOpeningTag This method generates the beginning of the opening tag. The abstract HTMLElement superclass will provide the remainder of the opening tag, repleate with attributes common to all html elements, such as name, and id, and class.
AppendClosingLineBreak (inherited from HTMLElement) 
AppendClosingTag This method generates the closing tag of this html element. If the providesClosingTag method returns false, then this method will never be called.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetChildInMidRender (inherited from HTMLElement) Call this method to obtain a reference to the child that is in mid render.
GetDisplayOptions (inherited from HTMLElement) Helper method to do lazy initialization of display options. Call this method to get the display options for display of this HTML tree. This method will only return a meaningful value during the execution of the display methods. This value will be cleared when display is finished.
GetDisplayString (inherited from HTMLElement)Overloaded. Call this method to obtain a String of HTML markup that represents this HTML element, and all HTML elements nested within.
GetHTMLElementReadOnly (inherited from HTMLElement) 
GetLastChildFullyRendered (inherited from HTMLElement) Call this method to obtain a reference to the last child that fully rendered.
GetStringBuilder (inherited from HTMLElement) This method is used to get a reasonable sized String Builder. It should be overridden by larger HTMLElements such as HTMLPage.
InternalWrite HTMLElement.InternalWrite rewritten.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
ProvidesClosingTag Indicates whether or not this HTML element provides a closing tag. Some elements only provide opening tags, such as the <br> element.
SetChildInMidRender (inherited from HTMLElement) Call this method to set the member reference to the child that is in mid render.
SetDisplayOptions (inherited from HTMLElement) Call this method to set the display options for this HTML tree.

This method is called internally during the execution of display methods.
SetHTMLElementReadOnly (inherited from HTMLElement) 
SetInner (inherited from HTMLElement) Call this method to set the internal XPArrayList of nested HTMLElement objects. Warning: This will erase all elements previously added to this element through calls to AddInnerHTMLElement.
SetLastChildFullyRendered (inherited from HTMLElement) Call this method to set the member reference to the last child fully rendered.
VerifyWritability (inherited from HTMLElement) This method checks whether or not this tree is read only and throws an exception if it is not.
WriteNugget (inherited from HTMLElement)Overloaded. This protected method is used by this class an all subclasses to write the smallest divisible units of HTML. These nuggets of HTML are either appended to an XPStringBuilder, written to the IXPResponse, both, or neither.

See Also

HTMLScriptCollection Class | com.plumtree.xpshared.htmlelements Namespace