ContentBox Core API 1.6.0

contentbox.widgets
Class RSS

WEB-INF.cftags.component
        extended by coldbox.system.FrameworkSupertype
            extended by coldbox.system.Plugin
                extended by contentbox.model.ui.BaseWidget
                    extended by contentbox.widgets.RSS

public class RSS
extends BaseWidget

A widget that reads an RSS feed and displays the items

Constructor Summary
init([any controller])
 
Method Summary
private any buildList(any entries, any showBody, any linkTarget)
 any renderIt(any feedURL, [numeric maxItems='5'], [boolean showBody='true'], [string linkTarget='_blank'], [string title=''], [string titleLevel='2'])
          A widget that reads an RSS feed and displays the items
 
Methods inherited from class contentbox.model.ui.BaseWidget
GETAUTHORSERVICE, GETCATEGORY, GETCATEGORYSERVICE, GETCB, GETCOMMENTSERVICE, GETCONTENTSERVICE, GETCONTENTSTORESERVICE, GETCONTENTVERSIONSERVICE, GETENTRYSERVICE, GETFORGEBOXSLUG, GETHTML, GETICON, GETPAGESERVICE, GETSECURITYSERVICE, SETAUTHORSERVICE, SETCATEGORY, SETCATEGORYSERVICE, SETCB, SETCOMMENTSERVICE, SETCONTENTSERVICE, SETCONTENTSTORESERVICE, SETCONTENTVERSIONSERVICE, SETENTRYSERVICE, SETFORGEBOXSLUG, SETHTML, SETICON, SETPAGESERVICE, SETSECURITYSERVICE, getPublicMethods
 
Methods inherited from class coldbox.system.Plugin
getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL
 
Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getInterceptor, getMailService, getMailSettings, getMemento, getModel, getModuleSettings, getMyPlugin, getNewMail, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getValidationManager, getfwLocale, includeUDF, loadGlobalUDFLibraries, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderLayout, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists, validateModel
 
Methods inherited from class WEB-INF.cftags.component
None
 

Constructor Detail

init

public init([any controller])

Parameters:
controller
Method Detail

buildList

private any buildList(any entries, any showBody, any linkTarget)

Parameters:
entries
showBody
linkTarget

renderIt

public any renderIt(any feedURL, [numeric maxItems='5'], [boolean showBody='true'], [string linkTarget='_blank'], [string title=''], [string titleLevel='2'])
A widget that reads an RSS feed and displays the items

Overrides:
renderIt in class BaseWidget
Parameters:
feedURL - The rss feed URL
maxItems - The maximum number of items to display, default is 5
showBody - Show the body of the feed item or not, default is true
linkTarget - The link target (HTML) for the RSS item link, defaults to _blank
title - The title to show before the dropdown or list, defaults to H2
titleLevel - The H{level} to use, by default we use H2

ContentBox Core API 1.6.0