Package org.tealeaf.javamarkdown.elements

Class Image

java.lang.Object

org.tealeaf.javamarkdown.MarkdownElement

org.tealeaf.javamarkdown.types.InlineElement

org.tealeaf.javamarkdown.elements.Link

org.tealeaf.javamarkdown.elements.Image

public class Image
extends Link

Displays an image within the document. Allows specifying the alt text.

Since:

0.0.12

Author:

Thomas Kwashnak

Constructor Summary

Constructors

Constructor	Description
Image(String src)	Implements an image with no alt text.
Image(String alt, String src)

Method Summary

Modifier and Type	Method	Description
String	asString()	Formats the string into the link syntax used in Markdown

Methods inherited from class org.tealeaf.javamarkdown.elements.Link

checkType

Methods inherited from class org.tealeaf.javamarkdown.types.InlineElement

requiresNewlineAfter, requiresNewlineBefore

Methods inherited from class org.tealeaf.javamarkdown.MarkdownElement

asString, toAppendable, toString, toWriter

Methods inherited from class java.lang.Object

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

Constructor Details

Image

public Image(String src)

Implements an image with no alt text.

Parameters:

src - Image source url

Since:

0.0.12

Image

public Image(String alt,
 String src)

Parameters:

alt - Alternate text used for the image

src - Image source url

Since:

0.0.12

Method Details

asString

public String asString()

Formats the string into the link syntax used in Markdown

Overrides:

asString in class Link

Returns:

String representation of the formatted item

Since:

0.0.12