TV-Browser 2.7.5 API

tvbrowser.extras.favoritesplugin
Class FavoritesPlugin

java.lang.Object
  extended by tvbrowser.extras.favoritesplugin.FavoritesPlugin

public class FavoritesPlugin
extends Object

Plugin for managing the favorite programs.

Author:
Til Schneider, www.murfman.de

Field Summary
static Localizer mLocalizer
          The localizer for this class.
static java.util.logging.Logger mLog
           
 
Method Summary
 void addPendingFavorite(AdvancedFavorite fav)
          Adds a AdvancedFavorite to the pending list (for loading filters after TV-Browser start was finished).
 void addProgramsForSending(ProgramReceiveTarget[] targets, Program[] programs)
          Add the programs to send to other Plugins to a Hashtable.
 void askAndDeleteFavorite(Favorite fav)
           
 void editFavorite(Favorite favorite)
           
protected  ActionMenu getButtonAction()
           
 ProgramReceiveTarget[] getClientPluginTargetIds()
           
protected  ActionMenu getContextMenuActions(Program program)
           
 ProgramReceiveTarget[] getDefaultClientPluginsTargets()
           
 ImageIcon getFavoritesIcon(int size)
           
 Exclusion[] getGlobalExclusions()
          Gets the global exclusions.
 ImageIcon getIconFromTheme(String category, String Icon, int size)
           
 String getId()
           
static FavoritesPlugin getInstance()
           
 ThemeIcon getMarkIconFromTheme()
           
protected  int getMarkPriority()
           
 PluginTreeNode getRootNode()
           
 Properties getSettings()
           
 void handleTvBrowserIsShuttingDown()
           
 void handleTvBrowserStartFinished()
           
 boolean isAutoSelectingRemider()
          Gets if reminder should be automatically selected for new Favorites
 boolean isShowingBlackListEntries()
           
 boolean isShowingPictures()
           
protected  boolean isShowingRepetitions()
           
 boolean isUsingExpertMode()
           
protected  void saveFavorites()
           
protected  void setAutoSelectingReminder(boolean value)
           
 void setClientPluginTargets(ProgramReceiveTarget[] clientPluginTargetArr)
           
protected  void setGlobalExclusions(Exclusion[] exclusions)
           
 void setIsShowingBlackListEntries(boolean value)
          Set the value for showing black list entries in the management dialog.
 void setIsShowingPictures(boolean value)
           
 void setIsUsingExpertMode(boolean value)
           
protected  void setMarkPriority(int priority)
           
protected  void setShowRepetitions(boolean value)
           
 void showCreateFavoriteWizard(Program program)
           
 void showCreateFavoriteWizard(Program program, String path)
           
 void showExcludeProgramsDialog(Favorite fav, Program program)
           
 void showInfoDialog()
           
 void store()
           
 String toString()
           
 void updateRootNode(boolean save)
           
 void waitForFinishingUpdateThreads()
          Waits for finishing the update threads.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

mLog

public static final java.util.logging.Logger mLog

mLocalizer

public static final Localizer mLocalizer
The localizer for this class.

Method Detail

waitForFinishingUpdateThreads

public void waitForFinishingUpdateThreads()
Waits for finishing the update threads.

Since:
2.7.2

handleTvBrowserIsShuttingDown

public void handleTvBrowserIsShuttingDown()

getInstance

public static FavoritesPlugin getInstance()

handleTvBrowserStartFinished

public void handleTvBrowserStartFinished()

store

public void store()

getIconFromTheme

public ImageIcon getIconFromTheme(String category,
                                  String Icon,
                                  int size)

addProgramsForSending

public void addProgramsForSending(ProgramReceiveTarget[] targets,
                                  Program[] programs)
Add the programs to send to other Plugins to a Hashtable.

Parameters:
targets - The ProgramReceiveTargets to send the programs for.
programs - The Programs to send.

isShowingBlackListEntries

public boolean isShowingBlackListEntries()
Returns:
If the management dialog should show the programs on the black list too.

setIsShowingBlackListEntries

public void setIsShowingBlackListEntries(boolean value)
Set the value for showing black list entries in the management dialog.

Parameters:
value - If the programs are to show.

getButtonAction

protected ActionMenu getButtonAction()

getContextMenuActions

protected ActionMenu getContextMenuActions(Program program)

editFavorite

public void editFavorite(Favorite favorite)

isUsingExpertMode

public boolean isUsingExpertMode()

setIsUsingExpertMode

public void setIsUsingExpertMode(boolean value)

isShowingPictures

public boolean isShowingPictures()

setIsShowingPictures

public void setIsShowingPictures(boolean value)

showCreateFavoriteWizard

public void showCreateFavoriteWizard(Program program)

showCreateFavoriteWizard

public void showCreateFavoriteWizard(Program program,
                                     String path)

saveFavorites

protected void saveFavorites()

showExcludeProgramsDialog

public void showExcludeProgramsDialog(Favorite fav,
                                      Program program)

askAndDeleteFavorite

public void askAndDeleteFavorite(Favorite fav)

getMarkIconFromTheme

public ThemeIcon getMarkIconFromTheme()

getRootNode

public PluginTreeNode getRootNode()

updateRootNode

public void updateRootNode(boolean save)

getFavoritesIcon

public ImageIcon getFavoritesIcon(int size)

getClientPluginTargetIds

public ProgramReceiveTarget[] getClientPluginTargetIds()

setClientPluginTargets

public void setClientPluginTargets(ProgramReceiveTarget[] clientPluginTargetArr)

getDefaultClientPluginsTargets

public ProgramReceiveTarget[] getDefaultClientPluginsTargets()

getId

public String getId()

getSettings

public Properties getSettings()
Returns:
The settings of the FavoritesPlugin.
Since:
2.2.2

addPendingFavorite

public void addPendingFavorite(AdvancedFavorite fav)
Adds a AdvancedFavorite to the pending list (for loading filters after TV-Browser start was finished).

Parameters:
fav - The AdvancedFavorite to add.
Since:
2.5.1

isShowingRepetitions

protected boolean isShowingRepetitions()

setShowRepetitions

protected void setShowRepetitions(boolean value)

isAutoSelectingRemider

public boolean isAutoSelectingRemider()
Gets if reminder should be automatically selected for new Favorites

Returns:
If the reminder should be selected.

setAutoSelectingReminder

protected void setAutoSelectingReminder(boolean value)

getMarkPriority

protected int getMarkPriority()

setMarkPriority

protected void setMarkPriority(int priority)

toString

public String toString()
Overrides:
toString in class Object

setGlobalExclusions

protected void setGlobalExclusions(Exclusion[] exclusions)

getGlobalExclusions

public Exclusion[] getGlobalExclusions()
Gets the global exclusions.

Returns:
The global exclusions.

showInfoDialog

public void showInfoDialog()

TV-Browser 2.7.5 API

TV-Browser 2.7.5, Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)