Package de.hsh.graja.util.comment

Class Inline

java.lang.Object

de.hsh.graja.util.comment.Content

de.hsh.graja.util.comment.AbstractElementContent

de.hsh.graja.util.comment.Inline

All Implemented Interfaces:

Serializable

public class Inline
extends AbstractElementContent

This content is rendered as a "span" inside a paragraph. A subsequent content will begin immediately after this content without a line break or paragraph delimiter.

Usage example:

InlineContent.format(includeSpec, "%s: %d", "Expected result", 15);

See Also:

• Serialized Form

Field Summary

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

EXCLUSIVE, renderUuid

Constructor Summary

Constructors

Constructor	Description
Inline(IncludeSpec includeSpec, String data)	Create a new content with default (normal) font.
Inline(IncludeSpec includeSpec, String data, FontWeightAndStyle fwas)	Create a new content.
Inline(IncludeSpec includeSpec, String data, FontWeightAndStyle fwas, WhiteSpace whiteSpace)	Create a new content.
Inline(String data)	Create a new content with default (normal) font and no include spec.
Inline(String data, FontWeightAndStyle fwas)	Create a new content without include spec

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)	implements the contract of Object.equals(Object).
static Inline	format(IncludeSpec includeSpec, String format, FontWeightAndStyle fwas, Object... args)	Convenience factory method for a formatted string.
static Inline	format(IncludeSpec includeSpec, String format, Object... args)	Convenience factory method for a formatted string.
static Inline	format(String format, FontWeightAndStyle fwas, Object... args)	Convenience factory method for a formatted string with no include spec.
static Inline	format(String format, Object... args)	Convenience factory method for a formatted string with no include spec.
String	getData()
FontWeightAndStyle	getFwas()
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 sb, IncludeInfo includeInfo, RenderContext ctx)	render content to plain text.
void	setData(String data)	Set new text
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

Inline

public Inline(String data,
 FontWeightAndStyle fwas)

Create a new content without include spec

Parameters:

data - the text of the comment

fwas - the font

Inline

public Inline(IncludeSpec includeSpec,
 String data,
 FontWeightAndStyle fwas)

Create a new content.

Parameters:

includeSpec - the include spec of the comment

data - the text of the comment

fwas - the font

Inline

public Inline(IncludeSpec includeSpec,
 String data,
 FontWeightAndStyle fwas,
 WhiteSpace whiteSpace)

Create a new content.

Parameters:

includeSpec - the include spec of the comment

data - the text of the comment

fwas - the font

whiteSpace - the white space specification

Inline

public Inline(IncludeSpec includeSpec,
 String data)

Create a new content with default (normal) font.

Parameters:

includeSpec - the include spec of the comment

data - the text of the comment

Inline

public Inline(String data)

Create a new content with default (normal) font and no include spec.

Parameters:

data - the text of the comment

Method Details

getData

public String getData()

Returns:

the text as it was passed to constructor or the setter.

setData

public void setData(String data)

Set new text

Parameters:

data - the new text

format

public static Inline format(IncludeSpec includeSpec,
 String format,
 FontWeightAndStyle fwas,
 Object... args)

Convenience factory method for a formatted string.

Parameters:

includeSpec - the include spec of the comment

format - a format string as defined by Formatter.format(String, Object...).

fwas - a font specification

args - arguments as expected by Formatter.format(String, Object...).

Returns:

a new instance

format

public static Inline format(String format,
 FontWeightAndStyle fwas,
 Object... args)

Convenience factory method for a formatted string with no include spec.

Parameters:

format - a format string as defined by Formatter.format(String, Object...).

fwas - a font specification

args - arguments as expected by Formatter.format(String, Object...).

Returns:

a new instance

format

public static Inline format(IncludeSpec includeSpec,
 String format,
 Object... args)

Convenience factory method for a formatted string.

Parameters:

includeSpec - the include spec of the comment

format - a format string as defined by Formatter.format(String, Object...).

args - arguments as expected by Formatter.format(String, Object...).

Returns:

a new instance with normal font.

format

public static Inline format(String format,
 Object... args)

Convenience factory method for a formatted string with no include spec.

Parameters:

format - a format string as defined by Formatter.format(String, Object...).

args - arguments as expected by Formatter.format(String, Object...).

Returns:

a new instance with normal font.

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)

getFwas

public FontWeightAndStyle getFwas()

Returns:

the font as it was passed to the constructor.

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:

• Content#renderHtmlImpl(StringBuilder, IncludeInfo, RenderContext)

renderPlainImpl

public void renderPlainImpl(StringBuilder sb,
 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:

sb - plain text result

includeInfo - controls, which content to be rendered.

ctx - render context (unused).

See Also:

• Content.renderPlainImpl(StringBuilder, IncludeInfo, RenderContext)