public interface PluginManager
Modifier and Type | Field and Description |
---|---|
static int |
SEARCHER_TYPE_BOOLEAN
Specifies, that the search term is a boolean expression.
|
static int |
SEARCHER_TYPE_EXACTLY
Specifies, that the search term has to match exacly.
|
static int |
SEARCHER_TYPE_KEYWORD
Specifies, that the search term is a keyword (= substring).
|
static int |
SEARCHER_TYPE_REGULAR_EXPRESSION
Specifies, that the search term is a regular expression.
|
Modifier and Type | Method and Description |
---|---|
JPopupMenu |
createPluginContextMenu(Program program,
ContextMenuIf caller)
Creates a context menu for the given program containing all plugins.
|
ProgramSearcher |
createProgramSearcher(int type,
String searchTerm,
boolean caseSensitive)
Creates a ProgramSearcher.
|
PluginAccess |
getActivatedPluginForId(String pluginId)
Gets the activated plugin with the given ID.
|
PluginAccess[] |
getActivatedPlugins()
Returns all activated Plugins.
|
ProgramFilter[] |
getAvailableFilters()
Deprecated.
since 2.2.5 Use
FilterManager.getAvailableFilters() instead. |
Iterator |
getChannelDayProgram(Date date,
Channel channel)
Gets an iterator through all programs of the specified channel at the
specified date.
|
TvDataService |
getDataService(String dataServiceClassName)
Deprecated.
|
TvDataServiceProxy |
getDataServiceProxy(String id) |
Program |
getExampleProgram()
Returns an example program.
|
FilterManager |
getFilterManager()
Returns the filter manager of TV-Browser (2.2.x version).
|
ImageIcon |
getIconFromTheme(Plugin plugin,
String category,
String icon,
int size)
Returns an Icon from the Icon-Theme-System
If your Plugin has Icons that are not available as Icons within an Theme, you can add
your Icons into your Jar-File.
|
ImageIcon |
getIconFromTheme(Plugin plugin,
ThemeIcon icon)
Returns an Icon from the Icon-Theme-System
If your Plugin has Icons that are not available as Icons within an Theme, you can add
your Icons into your Jar-File.
|
Plugin[] |
getInstalledPlugins()
Deprecated.
Since 1.1. Use
getActivatedPlugins() instead. |
String |
getJavaPluginId(Plugin javaPlugin)
Gets the ID of the given Java plugin.
|
Program[] |
getMarkedPrograms()
Return all marked programs.
|
Program |
getProgram(Date date,
String progID)
Gets a program.
|
Channel[] |
getSubscribedChannels()
Gets all channels the user has subscribed.
|
TvBrowserSettings |
getTvBrowserSettings()
Returns some settings a plugin may need.
|
void |
handleProgramDoubleClick(Program program)
Handles a double click on a program.
|
void |
handleProgramDoubleClick(Program program,
ContextMenuIf caller)
Handles a double click on a program.
|
void |
handleProgramMiddleClick(Program program)
Handles a middle click on a program.
|
void |
handleProgramMiddleClick(Program program,
ContextMenuIf caller)
Handles a middle click on a program.
|
Program[] |
search(String regex,
boolean inTitle,
boolean inText,
boolean caseSensitive,
Channel[] channels,
Date startDate,
int nrDays)
Deprecated.
Use
createProgramSearcher(int, String, boolean)
instead. |
Program[] |
search(String regex,
boolean caseSensitive,
ProgramFieldType[] fieldArr,
Date startDate,
int nrDays,
Channel[] channels,
boolean sortByStartTime)
Deprecated.
Since 1.1. Use
createProgramSearcher(int, String, boolean)
instead. |
void |
showSettings(Plugin plugin)
Show the Settings-Dialog for a Plugin
|
void |
showSettings(String settingsItem)
Show the Settings-Dialog with a Specific SettingsItem
|
static final int SEARCHER_TYPE_EXACTLY
static final int SEARCHER_TYPE_KEYWORD
static final int SEARCHER_TYPE_REGULAR_EXPRESSION
static final int SEARCHER_TYPE_BOOLEAN
Program getProgram(Date date, String progID)
date
- The date when the program is shown.progID
- The ID of the program.null
if there is no such program.Channel[] getSubscribedChannels()
Iterator getChannelDayProgram(Date date, Channel channel)
date
- The date of the programs.channel
- The channel of the programs.null
if the requested data is not available.Program[] search(String regex, boolean inTitle, boolean inText, boolean caseSensitive, Channel[] channels, Date startDate, int nrDays) throws TvBrowserException
createProgramSearcher(int, String, boolean)
instead.regex
- The regular expression programs must match to.inTitle
- Should be searched in the title?inText
- Should be searched in the desription?caseSensitive
- Should the search be case sensitive?channels
- The channels to search in.startDate
- The date to start the search.nrDays
- The number of days to include after the start date. If
negative the days before the start date are used.TvBrowserException
- If there is a syntax error in the regular expression.Program[] search(String regex, boolean caseSensitive, ProgramFieldType[] fieldArr, Date startDate, int nrDays, Channel[] channels, boolean sortByStartTime) throws TvBrowserException
createProgramSearcher(int, String, boolean)
instead.regex
- The regular expression programs must match to.caseSensitive
- Should the search be case sensitive?fieldArr
- The fields to search instartDate
- The date to start the search.nrDays
- The number of days to include after the start date. If
negative the days before the start date are used.channels
- The channels to search in.sortByStartTime
- Should the results be sorted by the start time?
If not, the results will be grouped by date and channel and the
search will be faster.TvBrowserException
TvBrowserException
- If there is a syntax error in the regular expression.ProgramSearcher createProgramSearcher(int type, String searchTerm, boolean caseSensitive) throws TvBrowserException
type
- The searcher type to create. Must be one of
SEARCHER_TYPE_EXACTLY
, SEARCHER_TYPE_KEYWORD
,
SEARCHER_TYPE_REGULAR_EXPRESSION
or
SEARCHER_TYPE_BOOLEAN
.searchTerm
- The search term the searcher should look for.caseSensitive
- Specifies whether the searcher should be case sensitive.TvBrowserException
- If creating the program searcher failed.PluginAccess[] getActivatedPlugins()
String getJavaPluginId(Plugin javaPlugin)
javaPlugin
- The Java plugin to get the ID for.PluginAccess getActivatedPluginForId(String pluginId)
pluginId
- The ID of the wanted plugin.null
if no such plugin
exists or if the plugin is not activated.Plugin[] getInstalledPlugins()
getActivatedPlugins()
instead.
This method always returns an empty array! Use
getActivatedPlugins()
instead!
TvDataService getDataService(String dataServiceClassName)
dataServiceClassName
- the class name of the wanted TvDataService.null
if there is no such
TvDataService.TvDataServiceProxy getDataServiceProxy(String id)
JPopupMenu createPluginContextMenu(Program program, ContextMenuIf caller)
program
- The program to create the context menu forcaller
- The calling plugin.ProgramFilter[] getAvailableFilters()
FilterManager.getAvailableFilters()
instead.Program getExampleProgram()
void handleProgramDoubleClick(Program program)
Executes the default context menu plugin. Plugins should use handleProgramDoubleClick(Program program, Plugin caller). It prevents the Plugin to be activated a second time.
program
- The program to pass to the default context menu plugin.void handleProgramDoubleClick(Program program, ContextMenuIf caller)
Executes the default context menu plugin.
program
- The program to pass to the default context menu plugin.caller
- The ContextMenuIf that calls this. Prevents the ContextMenuIf
to be activated twicevoid handleProgramMiddleClick(Program program)
Executes the middle click context menu plugin. Plugins should use handleProgramMiddleClick(Program program, Plugin caller). It prevents the Plugin to be activated a second time.
program
- The program to pass to the middle click context menu plugin.void handleProgramMiddleClick(Program program, ContextMenuIf caller)
Executes the middle click context menu plugin.
program
- The program to pass to the middle click context menu plugin.caller
- The ContextMenuIf that calls this. Prevents the ContextMenuIf
to be activated twice.TvBrowserSettings getTvBrowserSettings()
ImageIcon getIconFromTheme(Plugin plugin, String category, String icon, int size)
plugin
- Plugin that wants to load an Iconcategory
- Category of the Icon (Action, etc...)icon
- Icon-Name without File-Extensionsize
- Size of the IconImageIcon getIconFromTheme(Plugin plugin, ThemeIcon icon)
plugin
- Plugin that wants to load an Iconicon
- Icon in the Icon-Themesize
- Size of the Iconvoid showSettings(Plugin plugin)
plugin
- Use this Pluginvoid showSettings(String settingsItem)
settingsItem
- SettingsItem to show (e.g. SettingsItem.CHANNELS)Program[] getMarkedPrograms()
FilterManager getFilterManager()
null
if TV-Browser isn't fully loaded.TV-Browser 2.2.6, Copyright (C) 04-2003 Martin Oberhauser (martin@tvbrowser.org)