com.plumtree.xpshared.htmlelements
Class HTMLImg

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

All Implemented Interfaces:

java.lang.Cloneable

public class HTMLImg
extends HTMLElement

Use this class to render an html img element.

Spec

Nested Class Summary

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

HTMLElement.ValidationLevel

Field Summary

static boolean

bEnforceAlt Set this to false to cause the HTMLImg object to not enforce that the alt attribute is set to a valid String.

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

HTMLImg(java.lang.String src, java.lang.String alt)

HTMLImg(java.lang.String src, java.lang.String alt, java.lang.String height, java.lang.String width)

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	GetAlign() Get the value of the align attribute.
java.lang.String	GetAlt() Get the value of the alt attribute.
java.lang.String	GetBorder() Get the value of the border attribute.
java.lang.String	GetHeight() Get the value of the height attribute.
java.lang.String	GetSrc()
boolean	GetUseDisplayOptionsBaseUrl()
java.lang.String	GetUseMap() Get the value of the usemap attribute.
java.lang.String	GetWidth() Get the value of the width attribute.
protected boolean	ProvidesClosingTag() Indicates whether or not this HTML element provides a closing tag.
void	SetAlign(java.lang.String s) Set the value of the align atribute.
void	SetAlt(java.lang.String s) Set the value of the alt atribute.
void	SetBorder(java.lang.String s) Set the value of the border atribute.
void	SetHeight(java.lang.String s) Set the value of the height atribute.
void	SetUseDisplayOptionsBaseUrl(boolean b)
void	SetUseMap(java.lang.String s) Set the value of the usemap atribute.
void	SetWidth(java.lang.String s) Set the value of the width atribute.

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

Field Detail

bEnforceAlt

public static boolean bEnforceAlt

Set this to false to cause the HTMLImg object to not enforce that the alt attribute is set to a valid String.

Constructor Detail

HTMLImg

public HTMLImg(java.lang.String src,
               java.lang.String alt)

Parameters:

src - Pass the source string of this image.

alt - Pass the alt string of this image.

HTMLImg

public HTMLImg(java.lang.String src,
               java.lang.String alt,
               java.lang.String height,
               java.lang.String width)

Parameters:

src - Pass the source string of this image.

alt - Pass the alt string of this image.

height - Pass the height string of this image.

width - Pass the width string of this image.

Method Detail

GetAlign

public java.lang.String GetAlign()

Get the value of the align attribute.

Returns:

String value.

GetAlt

public java.lang.String GetAlt()

Get the value of the alt attribute.

Returns:

String value.

GetBorder

public java.lang.String GetBorder()

Get the value of the border attribute.

Returns:

String value.

GetHeight

public java.lang.String GetHeight()

Get the value of the height attribute.

Returns:

String value.

GetUseDisplayOptionsBaseUrl

public boolean GetUseDisplayOptionsBaseUrl()

GetWidth

public java.lang.String GetWidth()

Get the value of the width attribute.

Returns:

String value.

GetUseMap

public java.lang.String GetUseMap()

Get the value of the usemap attribute.

Returns:

String value.

SetAlign

public void SetAlign(java.lang.String s)

Set the value of the align atribute.

Parameters:

s - String value.

SetAlt

public void SetAlt(java.lang.String s)

Set the value of the alt atribute.

Parameters:

s - String value.

SetBorder

public void SetBorder(java.lang.String s)

Set the value of the border atribute.

Parameters:

s - String value.

SetHeight

public void SetHeight(java.lang.String s)

Set the value of the height atribute.

Parameters:

s - String value.

SetUseDisplayOptionsBaseUrl

public void SetUseDisplayOptionsBaseUrl(boolean b)

SetWidth

public void SetWidth(java.lang.String s)

Set the value of the width atribute.

Parameters:

s - String value.

SetUseMap

public void SetUseMap(java.lang.String s)

Set the value of the usemap atribute.

Parameters:

s - String value.

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

GetSrc

public java.lang.String GetSrc()

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.