net.sourceforge.rssowl.model
Class TabItemData

java.lang.Object
  net.sourceforge.rssowl.model.TabItemData

public class TabItemData
extends java.lang.Object

Model class to store data in a TabItem. The setData() Method of any TabItem in RSSOwl is used with a TabItemData Object.

Version:

1.2.4

Author:

Benjamin Pasero

Field Summary

private Category	aggregatedCategory
private Channel	channel
private Table	newsHeaderTableWidget
private NewsTable	newsTable
private BrowserPanel	rssOwlBrowserPanel
private boolean	showsUnreadNews
private java.lang.String	title
private int	type
private static int	TYPE_BROWSER Tab is displaying a browser
private static int	TYPE_ERROR Tab is displaying a warning
private static int	TYPE_FEED Tab is displaying a feed
private static int	TYPE_MESSAGE Tab is displaying a message
private java.lang.String	url

Constructor Summary

private

TabItemData(java.lang.String url, java.lang.String title, Category aggregatedCategory, NewsTable newsTable, Table newsHeaderTableWidget, Channel channel, BrowserPanel rssOwlBrowserPanel, int type) Private constructor which is used by the factory methods.

Method Summary

static TabItemData	createBrowserData(BrowserPanel rssOwlBrowserPanel) Create a new TabItemData with the type: Browser
static TabItemData	createErrorData(java.lang.String urlOrTitle) Create a new TabItemData with the type: Error
static TabItemData	createFeedData(java.lang.String url, java.lang.String title, Channel channel, NewsTable newsTable, Table newsHeaderTable) Create a new TabItemData with the type: Feed
static TabItemData	createMessageData(java.lang.String urlOrTitle) Create a new TabItemData with the type: Message
void	dispose() Dispose this TabItemData Object
Category	getAggregatedCategory()
Channel	getChannel()
Table	getNewsHeaderTable()
NewsTable	getNewsTable() Gets the NewsTable Proxy.
BrowserPanel	getRSSOwlBrowserPanel()
java.lang.String	getTitle()
java.lang.String	getUrl()
boolean	isAggregatedCat()
boolean	isBrowser()
boolean	isError()
boolean	isFeed()
boolean	isMessage()
boolean	isShowsUnreadNews() Status flag to remember the TabItems state
void	setShowsUnreadNews(boolean showsUnreadNews) Set the status flag to remember the TabItems state
boolean	showsCategory(Category category) Check if the given Category is aggregated in this TabItem

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_BROWSER

private static final int TYPE_BROWSER

Tab is displaying a browser

See Also:

Constant Field Values

TYPE_ERROR

private static final int TYPE_ERROR

Tab is displaying a warning

See Also:

Constant Field Values

TYPE_FEED

private static final int TYPE_FEED

Tab is displaying a feed

See Also:

Constant Field Values

TYPE_MESSAGE

private static final int TYPE_MESSAGE

Tab is displaying a message

See Also:

Constant Field Values

aggregatedCategory

private Category aggregatedCategory

channel

private Channel channel

newsHeaderTableWidget

private Table newsHeaderTableWidget

newsTable

private NewsTable newsTable

rssOwlBrowserPanel

private BrowserPanel rssOwlBrowserPanel

showsUnreadNews

private boolean showsUnreadNews

title

private java.lang.String title

type

private int type

url

private java.lang.String url

Constructor Detail

TabItemData

private TabItemData(java.lang.String url,
                    java.lang.String title,
                    Category aggregatedCategory,
                    NewsTable newsTable,
                    Table newsHeaderTableWidget,
                    Channel channel,
                    BrowserPanel rssOwlBrowserPanel,
                    int type)

Private constructor which is used by the factory methods.

Parameters:

url - The URL of the feed

title - The title of the feed

aggregatedCategory - If this is an aggregation, the aggregated category

newsHeaderTableWidget - The table holding the newsheader of the feed

channel - The displayed channel if this tab is displaying a feed

rssOwlBrowserPanel - The browser panel if a browser is displayed

type - The type of the tab

Method Detail

createBrowserData

public static TabItemData createBrowserData(BrowserPanel rssOwlBrowserPanel)

Create a new TabItemData with the type: Browser

Parameters:

rssOwlBrowserPanel - The browserpanel used by the browser

Returns:

TabItemData An instance of TabItemData

createErrorData

public static TabItemData createErrorData(java.lang.String urlOrTitle)

Create a new TabItemData with the type: Error

Parameters:

urlOrTitle - URL or Title of the Error

Returns:

TabItemData An instance of TabItemData

createFeedData

public static TabItemData createFeedData(java.lang.String url,
                                         java.lang.String title,
                                         Channel channel,
                                         NewsTable newsTable,
                                         Table newsHeaderTable)

Create a new TabItemData with the type: Feed

Parameters:

url - The URL of the feed

title - The title of the feed

channel - The displayed channel if this tab is displaying a feed

newsTable - The NewsTable proxy

newsHeaderTable - The table holding the newsheader of the feed

Returns:

TabItemData An instance of TabItemData

createMessageData

public static TabItemData createMessageData(java.lang.String urlOrTitle)

Create a new TabItemData with the type: Message

Parameters:

urlOrTitle - URL or Title of the Message / Error

Returns:

TabItemData An instance of TabItemData

dispose

public void dispose()

Dispose this TabItemData Object

getAggregatedCategory

public Category getAggregatedCategory()

Returns:

Category If this is an aggregation, the aggregated category

getChannel

public Channel getChannel()

Returns:

Returns the channel that is displayed

getNewsHeaderTable

public Table getNewsHeaderTable()

Returns:

Returns the newsHeaderTable.

getNewsTable

public NewsTable getNewsTable()

Gets the NewsTable Proxy.

Returns:

NewsTable The NewsTable Proxy.

getRSSOwlBrowserPanel

public BrowserPanel getRSSOwlBrowserPanel()

Returns:

Returns the rssOwlBrowserPanel.

getTitle

public java.lang.String getTitle()

Returns:

Returns the title.

getUrl

public java.lang.String getUrl()

Returns:

Returns the url.

isAggregatedCat

public boolean isAggregatedCat()

Returns:

boolean TRUE if the Feed is an aggregated category

isBrowser

public boolean isBrowser()

Returns:

boolean TRUE if the Type is Browser

isError

public boolean isError()

Returns:

boolean TRUE if the Type is Message

isFeed

public boolean isFeed()

Returns:

boolean TRUE if the Type is Feed

isMessage

public boolean isMessage()

Returns:

boolean TRUE if the Type is Message

isShowsUnreadNews

public boolean isShowsUnreadNews()

Status flag to remember the TabItems state

Returns:

boolean Returns the showsUnreadNews.

setShowsUnreadNews

public void setShowsUnreadNews(boolean showsUnreadNews)

Set the status flag to remember the TabItems state

Parameters:

showsUnreadNews - The showsUnreadNews to set.

showsCategory

public boolean showsCategory(Category category)

Check if the given Category is aggregated in this TabItem

Parameters:

category - The category to check if shown

Returns:

boolean TRUE in case this tabitem is showing an aggregation of the given category