org.xwiki.rendering.macro.rss

Class RssMacroParameters

java.lang.Object

org.xwiki.rendering.macro.box.BoxMacroParameters

org.xwiki.rendering.macro.rss.RssMacroParameters

public class RssMacroParameters
extends org.xwiki.rendering.macro.box.BoxMacroParameters

Parameters for the RssMacro Macro.

Since:

1.8RC1

Version:

$Id: 668ecc06779b812955cfe7d29f98f902fae0bd07 $

Constructor Summary

Constructors

Constructor and Description
RssMacroParameters()

Method Summary

Modifier and Type	Method and Description
int	getCount()
String	getEncoding()
String	getFeed()
URL	getFeedURL()
String	getWidth()
boolean	isContent()
boolean	isDecoration()
boolean	isImage()
void	setContent(boolean content)
void	setCount(int count)
void	setDecoration(boolean decoration)
void	setEncoding(String encoding)
void	setFeed(String feed)
void	setImage(boolean image)
void	setWidth(String width)

Methods inherited from class org.xwiki.rendering.macro.box.BoxMacroParameters

getBlockTitle, getCssClass, getImage, getTitle, setBlockTitle, setCssClass, setImage, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

RssMacroParameters

public RssMacroParameters()

Method Detail

getFeed

public String getFeed()

Returns:

the RSS feed URL.

setFeed

public void setFeed(String feed)
             throws org.xwiki.rendering.macro.parameter.MacroParameterException

Parameters:

feed - the RSS feed URL.

Throws:

org.xwiki.rendering.macro.parameter.MacroParameterException - if the feed URL is malformed.

setImage

public void setImage(boolean image)

Parameters:

image - whether to display the feed's image.

isImage

public boolean isImage()

Returns:

whether to display the feed's image.

setWidth

public void setWidth(String width)

Overrides:

setWidth in class org.xwiki.rendering.macro.box.BoxMacroParameters

Parameters:

width - the width of the RSS box, that will dismiss potential CSS rules defining its default value.

getWidth

public String getWidth()

Overrides:

getWidth in class org.xwiki.rendering.macro.box.BoxMacroParameters

Returns:

the width of the RSS box, that will dismiss potential CSS rules defining its default value.

setCount

public void setCount(int count)

Parameters:

count - the number of feed items to display.

getCount

public int getCount()

Returns:

the number of feed items to display.

getFeedURL

public URL getFeedURL()

Returns:

the feed's URL

setContent

public void setContent(boolean content)

Parameters:

content - if "true" displays the content of each feed in addition to the feed item link

isContent

public boolean isContent()

Returns:

true if the content of each feed should be displayed

setDecoration

public void setDecoration(boolean decoration)

Parameters:

decoration - if "true" displays UI decorations around feed and feed entries (RSS feed icon, feed items in boxes, etc).

isDecoration

public boolean isDecoration()

Returns:

true if UI decorations should be displayed

setEncoding

public void setEncoding(String encoding)

Parameters:

encoding - the encoding to use when reading the RSS Feed

getEncoding

public String getEncoding()

Returns:

the encoding to use when reading the RSS Feed. If not specified then it's guessed from a variety of places (XML header, BOM, XML Prolog, etc). In general this parameter shouldn't be used.