com.plumtree.xpshared.htmlelements
Class HTMLArea

java.lang.Object
  com.plumtree.xpshared.htmlelements.HTMLElement
      com.plumtree.xpshared.htmlelements.HTMLArea

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLArea
extends HTMLElement

Use this class to render an html area element.

Spec

Nested Class Summary

Nested classes/interfaces inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

HTMLElement.ValidationLevel

Field Summary

Fields inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

aNewLine, bAllowEvents, bAllowSetStyleClassWithString, bCheckNestedStringForHTML, bDisplayDidPause, bEnforceMaxTableDepth, bForceFormattingOff, bForceFormattingOn, bPauseAfterDisplay, bPrintComments, bResumingAndChildFinished, bResumingAndChildInMidRender, bShowLang, iMaxTableDepth, sLangLocal, sNewLine, sTab

Constructor Summary

HTMLArea(java.lang.String alt)
Constructs a new HTMLArea

HTMLArea(java.lang.String shape, java.lang.String alt, java.lang.String coords, java.lang.String href)
Constructs a new HTMLArea

Method Summary

protected void	AppendBeginningOfOpeningTag(boolean bFormat, XPStringBuilder sb, IXPResponse response) This method generates the beginning of the opening tag.
protected void	AppendClosingTag(boolean bFormat, XPStringBuilder sb, IXPResponse response) This method generates the closing tag of this html element.
java.lang.String	GetAlt() Get the value of the alt attribute.
java.lang.String	GetCoords() Get the value of the coords attribute
java.lang.String	GetHref() Get the value of the href attribute
boolean	GetNohref() Get the value of the nohref attribute
java.lang.String	GetShape() Get the value of the Shape attribute
java.lang.String	GetTarget() Get the value of the target attribute
protected boolean	ProvidesClosingTag() Indicates whether or not this HTML element provides a closing tag.
void	SetAlt(java.lang.String s) Set the value of the alt atribute.
void	SetCoords(java.lang.String sCoords) Sets the value of the coords attribute.
void	SetHref(java.lang.String sHref) Sets the value of the href attribute.
void	SetNohref(boolean bNohref) Sets the value of the nohref attribute .
void	SetShape(java.lang.String strShape) Set the value of the shape attribute.
void	SetTarget(java.lang.String sTarget) Sets the value of the target attribute.

Methods inherited from class com.plumtree.xpshared.htmlelements.HTMLElement

AddInnerHTMLElement, AddInnerHTMLEncodedString, AddInnerHTMLString, AppendClosingLineBreak, CleanupHTMLSubtreeAfterRendering, ClearInnerHTMLElements, clone, Display, Display, ForceFormattingOff, GetChildInMidRender, GetClone, GetDisabled, GetDisplayDidPause, GetDisplayOptions, GetDisplayString, GetDisplayString, GetDisplayString, GetDo508Checking, GetDoFormat, GetElementName, GetForceLineBreaksAfterSafeElements, GetHTMLElementReadOnly, GetID, GetImgBaseUrl, GetInnerHTML, GetInnerHTML, GetInnerHTMLDisplayString, GetInnerHTMLElements, GetInnerHTMLElementsAsArrayList, GetIsNetscape, GetLang, GetLastChildFullyRendered, GetName, GetOnClick, GetOnKeyDown, GetOnKeyPress, GetOnKeyUp, GetOnMouseOut, GetOnMouseOver, GetPauseAfterDisplay, GetPostComment, GetPreComment, GetStringBuilder, GetStyle, GetStyleClass, GetStyleClassPrefix, GetTitle, GetValidationLevel, InsertInnerHTMLElement, InternalWrite, SaveToTempFile, SaveToTempFile, SetChildInMidRender, SetDisabled, SetDisplayOptions, SetDo508Checking, SetDoFormat, SetElementName, SetFlushAfterDisplay, SetForceLineBreaksAfterSafeElements, SetHTMLElementReadOnly, SetID, SetImgBaseUrl, SetInner, SetIsNetscape, SetLangGlobal, SetLangLocal, SetLastChildFullyRendered, SetName, SetOnClick, SetOnKeyDown, SetOnKeyPress, SetOnKeyUp, SetOnMouseOut, SetOnMouseOver, SetPauseAfterDisplay, SetPostComment, SetPreComment, SetStyle, SetStyleClass, SetStyleClass, SetStyleClassPrefix, SetTitle, SetValidationLevel, ToByteArray, VerifyWritability, WriteNugget, WriteNugget

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLArea

public HTMLArea(java.lang.String alt)

Constructs a new HTMLArea

Parameters:

alt - Pass the alt string of this area.

HTMLArea

public HTMLArea(java.lang.String shape,
                java.lang.String alt,
                java.lang.String coords,
                java.lang.String href)

Constructs a new HTMLArea

Parameters:

alt - Pass the alt string of this area.

shape - Pass the shape string of this area.

coords - Pass the coordinates string of this area.

href - Pass the target URL string of this area.

Method Detail

GetAlt

public java.lang.String GetAlt()

Get the value of the alt attribute.

Returns:

String value.

GetNohref

public boolean GetNohref()

Get the value of the nohref attribute

Returns:

boolean

GetCoords

public java.lang.String GetCoords()

Get the value of the coords attribute

Returns:

String

GetHref

public java.lang.String GetHref()

Get the value of the href attribute

Returns:

String

GetShape

public java.lang.String GetShape()

Get the value of the Shape attribute

Returns:

String

GetTarget

public java.lang.String GetTarget()

Get the value of the target attribute

Returns:

String

SetNohref

public void SetNohref(boolean bNohref)

Sets the value of the nohref attribute .

Parameters:

bNohref -

SetCoords

public void SetCoords(java.lang.String sCoords)

Sets the value of the coords attribute.

Parameters:

sCoords - The coordinates to set

SetHref

public void SetHref(java.lang.String sHref)

Sets the value of the href attribute.

Parameters:

sHref - The href to set

SetTarget

public void SetTarget(java.lang.String sTarget)

Sets the value of the target attribute.

Parameters:

sTarget - The target to set

SetAlt

public void SetAlt(java.lang.String s)

Set the value of the alt atribute.

Parameters:

s - String value.

SetShape

public void SetShape(java.lang.String strShape)

Set the value of the shape attribute.

Parameters:

strShape - Either "rect", "rectangle", "circ", "circle", "poly", or "polygon".

Throws:

HTMLException

AppendBeginningOfOpeningTag

protected void AppendBeginningOfOpeningTag(boolean bFormat,
                                           XPStringBuilder sb,
                                           IXPResponse response)

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.

Specified by:

AppendBeginningOfOpeningTag in class HTMLElement

Parameters:

bFormat - boolean indicating whether or not to format.

sb - XPStringBuilder

response - IXPResponse

Throws:

HTMLException

AppendClosingTag

protected void AppendClosingTag(boolean bFormat,
                                XPStringBuilder sb,
                                IXPResponse response)

This method generates the closing tag of this html element. If the providesClosingTag method returns false, then this method will never be called.

Specified by:

AppendClosingTag in class HTMLElement

Parameters:

bFormat - boolean indicating whether or not to format.

sb - XPStringBuilder

response - IXPResponse

ProvidesClosingTag

protected boolean ProvidesClosingTag()

Indicates whether or not this HTML element provides a closing tag. Some elements only provide opening tags, such as the <br> element.

Specified by:

ProvidesClosingTag in class HTMLElement

Returns:

boolean false.