Package de.hsh.graja.util.comment

Class Image

java.lang.Object

de.hsh.graja.util.comment.Content

de.hsh.graja.util.comment.AbstractElementContent

de.hsh.graja.util.comment.Image

All Implemented Interfaces:

Serializable

public class Image
extends AbstractElementContent

This content is rendered as an image.

Example:

BufferedImage image= ...; // create an image
new Image(includeSpec, image);

An image content is embedded into HTML as data URL. Currently there is no support to render an image into plain text.

See Also:

• Serialized Form

Field Summary

Fields inherited from class de.hsh.graja.util.comment.Content

EXCLUSIVE, renderUuid

Constructor Summary

Constructors

Constructor	Description
Image(IncludeSpec includeSpec, int width, int height, String base64, String titleText)	Create a content with a given include spec and image data.
Image(IncludeSpec includeSpec, RenderedImage img, String titleText)	Create a content with a given include spec and image data.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	implements the contract of Object.equals(Object).
String	getBase64()
String	getTitleText()
int	hashCode()	implements the contract of Object.hashCode().
boolean	isInlineContent()
void	renderHtmlImpl(StringBuilder sb, IncludeInfo includeInfo, RenderContext ctx, boolean useJavascript)	render content to HTML.
void	renderPlainImpl(StringBuilder appender, IncludeInfo includeInfo, RenderContext ctx)	render content to plain text.
void	setMargin(int marginHorizontal, int marginVertical)	Set margin.
String	toString(String prefix)	This method is for debugging purposes.

Methods inherited from class de.hsh.graja.util.comment.AbstractElementContent

getNestedContents

Methods inherited from class de.hsh.graja.util.comment.Content

click, dehighlight, disableCallerStacktraceRecording, enableCallerStacktraceRecording, excludeGlobally, getIncludeSpec, getRenderUuid, getStackdump, hide, highlight, include, isCallerStacktraceRecordingEnabled, isHidden, isShowing, onClick, onClick, onHide, onHide, onLoad, onLoad, onShow, onShow, registerCallable, renderHtml, renderHtml, renderIdAttribute, renderJavascriptOncePerClass, renderOnClickAttribute, renderPlain, renderPlain, setGlobalIncludeInfo, setHref, setIncludeSpec, show, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Image

public Image(IncludeSpec includeSpec,
 RenderedImage img,
 String titleText)

Create a content with a given include spec and image data.

Parameters:

includeSpec - The include spec of the comment

img - the image data

titleText - optional title

Image

public Image(IncludeSpec includeSpec,
 int width,
 int height,
 String base64,
 String titleText)

Create a content with a given include spec and image data.

Parameters:

includeSpec - The include spec of the comment

width - mandatory width

height - mandatory height

base64 - mandatory base64 data

titleText - optional title

Method Details

getBase64

public String getBase64()

getTitleText

public String getTitleText()

setMargin

public void setMargin(int marginHorizontal,
 int marginVertical)

Set margin.

Parameters:

marginHorizontal - left and right margin in pixels

marginVertical - top and bottom margin in pixels

isInlineContent

public boolean isInlineContent()

Specified by:

isInlineContent in class Content

Returns:

true

See Also:

• Content.isInlineContent()

toString

public String toString(String prefix)

Description copied from class: Content

This method is for debugging purposes.

Overrides:

toString in class Content

Parameters:

prefix - If the output has multiple lines, prefix specifies the indentation of the subsequent lines.

Returns:

a string representation of the content and it's internal structure.

See Also:

• Content.toString(java.lang.String)

hashCode

public int hashCode()

implements the contract of Object.hashCode().

Overrides:

hashCode in class Content

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

implements the contract of Object.equals(Object).

Overrides:

equals in class Content

renderHtmlImpl

public void renderHtmlImpl(StringBuilder sb,
 IncludeInfo includeInfo,
 RenderContext ctx,
 boolean useJavascript)

Description copied from class: Content

render content to HTML. This method is meant to be overriden by subclasses.

Specified by:

renderHtmlImpl in class Content

Parameters:

sb - HTML code result

includeInfo - controls, which content to be rendered.

ctx - render context

useJavascript - if true, the generated HTML code will contain Javascript

See Also:

• de.hsh.graja.util.comment.Content#renderHtml(StringBuilder, IncludeInfo, RenderContext)

renderPlainImpl

public void renderPlainImpl(StringBuilder appender,
 IncludeInfo includeInfo,
 RenderContext ctx)

Description copied from class: Content

render content to plain text. This method is meant to be overriden by subclasses.

Specified by:

renderPlainImpl in class Content

Parameters:

appender - plain text result

includeInfo - controls, which content to be rendered.

ctx - render context (unused).

See Also:

• Content.renderPlainImpl(StringBuilder, IncludeInfo, RenderContext)