chameleon.rss

Class Image

java.lang.Object

chameleon.rss.Image

public class Image
extends Object

Specifies a GIF, JPEG or PNG image that can be displayed with the channel.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.
Integer	getHeight() Returns the number indicating the height of the image in pixels.
URI	getLink() Returns the URL of the site, when the channel is rendered, the image is a link to the site.
String	getLinkString() Returns the URL of the site, when the channel is rendered, the image is a link to the site.
String	getTitle() Describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.
URI	getURL() Returns the URL of a GIF, JPEG or PNG image that represents the channel.
String	getURLString() Returns the URL of a GIF, JPEG or PNG image that represents the channel.
Integer	getWidth() Returns the number indicating the width of the image in pixels.
void	setDescription(String description) Initializes the text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.
void	setHeight(Integer height) Initializes the number indicating the height of the image in pixels.
void	setLink(URI link) Initializes the URL of the site, when the channel is rendered, the image is a link to the site.
void	setLinkString(String link) Initializes the URL of the site, when the channel is rendered, the image is a link to the site.
void	setTitle(String title) Describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.
void	setURL(URI url) Initializes the URL of a GIF, JPEG or PNG image that represents the channel.
void	setURLString(String url) Initializes the URL of a GIF, JPEG or PNG image that represents the channel.
void	setWidth(Integer width) Initializes the number indicating the width of the image in pixels.

Methods inherited from class java.lang.Object

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

Constructor Detail

Image

public Image()

Method Detail

setURLString

public void setURLString(String url)
                  throws URISyntaxException

Initializes the URL of a GIF, JPEG or PNG image that represents the channel.

Parameters:

url - an URL as a string. Shall not be null.

Throws:

NullPointerException - if url is null.

URISyntaxException - if the given string violates RFC 2396, as augmented by the URI deviations.

See Also:

getURLString(), setURL(java.net.URI)

getURLString

public String getURLString()

Returns the URL of a GIF, JPEG or PNG image that represents the channel. No default value.

Returns:

an URL as a string. Shall not be null.

Throws:

NullPointerException - if no URL has been defined in this image description.

See Also:

setURLString(java.lang.String), getURL()

setURL

public void setURL(URI url)

Initializes the URL of a GIF, JPEG or PNG image that represents the channel.

Parameters:

url - an URL. Shall not be null.

Throws:

NullPointerException - if url is null.

See Also:

getURL(), setURLString(java.lang.String)

getURL

public URI getURL()

Returns the URL of a GIF, JPEG or PNG image that represents the channel.

Returns:

an URL. May be null if not yet initialized.

See Also:

setURL(java.net.URI), getURLString()

setTitle

public void setTitle(String title)

Describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.

Parameters:

title - the image's title. Shall not be null.

Throws:

NullPointerException - if title is null.

See Also:

getTitle()

getTitle

public String getTitle()

Describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML. No default value.

Returns:

the image's title. May be null if not yet initialized.

See Also:

setTitle(java.lang.String)

getLinkString

public String getLinkString()

Returns the URL of the site, when the channel is rendered, the image is a link to the site.

Returns:

an URL as a string. Shall not be null.

Throws:

NullPointerException - if no link has been defined in this image description.

See Also:

setLinkString(java.lang.String), getLink()

setLinkString

public void setLinkString(String link)
                   throws URISyntaxException

Initializes the URL of the site, when the channel is rendered, the image is a link to the site.

Parameters:

link - an URL as a string. Shall not be null.

Throws:

NullPointerException - if link is null.

URISyntaxException - if the given string violates RFC 2396, as augmented by the URI deviations.

See Also:

getLinkString(), setLink(java.net.URI)

setLink

public void setLink(URI link)

Initializes the URL of the site, when the channel is rendered, the image is a link to the site.

Parameters:

link - an URL. Shall not be null.

Throws:

NullPointerException - if link is null.

See Also:

getLink(), setLinkString(java.lang.String)

getLink

public URI getLink()

Returns the URL of the site, when the channel is rendered, the image is a link to the site. Note, in practice the image title and link should have the same value as the channel's title and link. No default value.

Returns:

an URL. May be null if not yet initialized.

See Also:

setLink(java.net.URI), getLinkString()

getWidth

public Integer getWidth()

Returns the number indicating the width of the image in pixels. Maximum value is 144 (not checked). If not specified, defaults to 88.

Returns:

a width. May be null.

See Also:

setWidth(java.lang.Integer)

setWidth

public void setWidth(Integer width)

Initializes the number indicating the width of the image in pixels.

Parameters:

width - a width. May be null.

See Also:

getWidth()

getHeight

public Integer getHeight()

Returns the number indicating the height of the image in pixels. Maximum value is 400 (not checked). If not specified, defaults to 31.

Returns:

a height. May be null.

See Also:

setHeight(java.lang.Integer)

setHeight

public void setHeight(Integer height)

Initializes the number indicating the height of the image in pixels.

Parameters:

height - a height. May be null.

See Also:

getHeight()

getDescription

public String getDescription()

Returns the text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.

Returns:

the image's description. May be null.

See Also:

setDescription(java.lang.String)

setDescription

public void setDescription(String description)

Initializes the text that is included in the TITLE attribute of the link formed around the image in the HTML rendering.

Parameters:

description - the image's description. May be null.

See Also:

getDescription()