public interface PluginManager
Modifier and Type | Field and Description |
---|---|
static int |
SEARCHER_TYPE_BOOLEAN
Deprecated.
sine 3.4.4 use
TYPE_SEARCHER_BOOLEAN instead |
static int |
SEARCHER_TYPE_EXACTLY
Deprecated.
sine 3.4.4 use
TYPE_SEARCHER_EXACTLY instead |
static int |
SEARCHER_TYPE_KEYWORD
Deprecated.
sine 3.4.4 use
TYPE_SEARCHER_KEYWORD instead |
static int |
SEARCHER_TYPE_REGULAR_EXPRESSION
Deprecated.
sine 3.4.4 use
TYPE_SEARCHER_REGULAR_EXPRESSION instead |
static int |
TYPE_SEARCHER_BOOLEAN
Specifies, that the search term is a boolean expression.
|
static int |
TYPE_SEARCHER_EXACTLY
Specifies, that the search term has to match exactly.
|
static int |
TYPE_SEARCHER_KEYWORD
Specifies, that the search term is a keyword (= substring).
|
static int |
TYPE_SEARCHER_REGULAR_EXPRESSION
Specifies, that the search term is a regular expression.
|
static int |
TYPE_SEARCHER_WHOLE_TERM
Specifies, that the search term is a whole term
(word boundaries are taken into account).
|
Modifier and Type | Method and Description |
---|---|
javax.swing.JPopupMenu |
createPluginContextMenu(Program program,
ContextMenuIf caller)
Creates a context menu for the given program containing all plugins.
|
ProgramSearcher |
createProgramSearcher(int type,
java.lang.String searchTerm,
boolean caseSensitive)
Creates a ProgramSearcher.
|
ProgressMonitorExtended |
createProgressMonitor()
Gets access to the progress and label of status bar.
|
javax.swing.JPopupMenu |
createRemovedProgramContextMenu(Program program)
Creates a context menu for the given program.
|
void |
deleteFileOnNextStart(java.lang.String path)
adds a file name to the list of files to be deleted on next TV-Browser start
|
PluginAccess |
getActivatedPluginForId(java.lang.String pluginId)
Gets the activated plugin with the given ID.
|
PluginAccess[] |
getActivatedPlugins()
Returns all activated Plugins.
|
ProgramRatingIf[] |
getAllProgramRatingIfs()
Gets all ProgramRatingIfs of all plugins.
|
AbstractPluginProgramFormating[] |
getAvailableGlobalPuginProgramFormatings()
Gets the available global program configurations.
|
java.util.Iterator<Program> |
getChannelDayProgram(Date date,
Channel channel)
Gets an iterator through all programs of the specified channel at the
specified date.
|
Date |
getCurrentDate()
Get the date currently shown in the program table.
|
TvDataServiceProxy |
getDataServiceProxy(java.lang.String id) |
Program |
getExampleProgram()
Returns an example program.
|
FilterManager |
getFilterManager()
Returns the filter manager of TV-Browser.
|
javax.swing.ImageIcon |
getIconFromTheme(Plugin plugin,
java.lang.String category,
java.lang.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.
|
javax.swing.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.
|
java.lang.String |
getJavaPluginId(Plugin javaPlugin)
Gets the ID of the given Java plugin.
|
Program[] |
getMarkedPrograms()
Return all marked programs.
|
Program |
getProgram(Date date,
java.lang.String progID)
Gets a program.
|
Program |
getProgram(java.lang.String uniqueID)
Gets a program.
|
Program[] |
getPrograms(Date date,
java.lang.String progID)
Gets programs.
|
Program[] |
getPrograms(java.lang.String uniqueID)
Gets programs.
|
ProgramReceiveIf |
getReceiceIfForId(java.lang.String id)
Return the ReceiveIfFor given id or
null if there is
no ReceiveIf for the given id. |
ProgramReceiveIf[] |
getReceiveIfs()
Return all Plugins/Functions that are able to receive programs.
|
ProgramReceiveIf[] |
getReceiveIfs(ProgramReceiveIf caller,
ProgramReceiveTarget callerTarget)
Return all Plugins/Functions that are able to receive programs.
|
Channel[] |
getSubscribedChannels()
Gets all channels the user has subscribed.
|
TvBrowserSettings |
getTvBrowserSettings()
Returns some settings a plugin may need.
|
Version |
getTVBrowserVersion() |
void |
goToDate(Date date)
Let TVB change the date to the given date.
|
void |
handleProgramDoubleClick(Program program)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramDoubleClick(Program program,
ContextMenuIf caller)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramMiddleClick(Program program)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramMiddleClick(Program program,
ContextMenuIf caller)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramMiddleDoubleClick(Program program)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramMiddleDoubleClick(Program program,
ContextMenuIf caller)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramSingleClick(Program program)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramSingleClick(Program program,
ContextMenuIf caller)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
void |
handleProgramSingleCtrlClick(Program program,
ContextMenuIf caller)
Deprecated.
since 3.3.1 Use
#ProgramMouseEventHandler and/or #ProgramKeyEventHandler instead. |
boolean |
isDataAvailable(Date date)
check if some TV data is available on the given date
|
boolean |
isTvBrowserStartFinished()
Gets if TV-Browser start was finished.
|
void |
scrollToChannel(Channel channel)
Let TVB scroll to the given channel.
|
void |
scrollToProgram(Program program)
Let TVB scroll to the given program.
|
void |
scrollToTime(int time)
Let TVB scroll to the given time.
|
void |
scrollToTime(int time,
boolean highlight)
Let TV-Browser scroll to the given time.
|
void |
selectProgram(Program program)
Selects the given program in the program table.
|
boolean |
showBalloonTip(java.lang.String caption,
java.lang.String message,
java.awt.TrayIcon.MessageType messageType)
Shows a balloon tip on the TV-Browser tray icon.
|
void |
showSettings(Plugin plugin)
Show the Settings-Dialog for a Plugin
|
void |
showSettings(java.lang.String settingsItem)
Show the Settings-Dialog with a Specific SettingsItem
|
static final int TYPE_SEARCHER_EXACTLY
static final int TYPE_SEARCHER_KEYWORD
static final int TYPE_SEARCHER_REGULAR_EXPRESSION
static final int TYPE_SEARCHER_BOOLEAN
static final int TYPE_SEARCHER_WHOLE_TERM
static final int SEARCHER_TYPE_EXACTLY
TYPE_SEARCHER_EXACTLY
insteadstatic final int SEARCHER_TYPE_KEYWORD
TYPE_SEARCHER_KEYWORD
insteadstatic final int SEARCHER_TYPE_REGULAR_EXPRESSION
TYPE_SEARCHER_REGULAR_EXPRESSION
insteadstatic final int SEARCHER_TYPE_BOOLEAN
TYPE_SEARCHER_BOOLEAN
insteadProgram getProgram(Date date, java.lang.String progID)
date
- The date when the program is shown.progID
- The ID of the program.null
if there is no such program.Program[] getPrograms(Date date, java.lang.String progID)
date
- The date when the programs are shown.progID
- The ID of the programs.null
if there are no such programs.Program getProgram(java.lang.String uniqueID)
uniqueID
- The unique ID (Program.getUniqueID()
) of this program.null
if there is no such program.Program[] getPrograms(java.lang.String uniqueID)
uniqueID
- The unique ID (Program.getUniqueID()
) of the programs.null
if there are no such programs.Channel[] getSubscribedChannels()
java.util.Iterator<Program> 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.ProgramSearcher createProgramSearcher(int type, java.lang.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()
java.lang.String getJavaPluginId(Plugin javaPlugin)
javaPlugin
- The Java plugin to get the ID for.PluginAccess getActivatedPluginForId(java.lang.String pluginId)
pluginId
- The ID of the wanted plugin.null
if no such plugin
exists or if the plugin is not activated.TvDataServiceProxy getDataServiceProxy(java.lang.String id)
javax.swing.JPopupMenu createPluginContextMenu(Program program, ContextMenuIf caller)
program
- The program to create the context menu forcaller
- The calling plugin.Program getExampleProgram()
void handleProgramSingleClick(Program program)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.Executes the single left click context menu function. 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 single left click context menu function.void handleProgramSingleClick(Program program, ContextMenuIf caller)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.Executes the default context menu plugin.
program
- The program to pass to the default context menu function.caller
- The ContextMenuIf that calls this. Prevents the ContextMenuIf
to be activated twicevoid handleProgramSingleCtrlClick(Program program, ContextMenuIf caller)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.Executes the default context menu plugin.
program
- The program to pass to the default context menu function.caller
- The ContextMenuIf that calls this. Prevents the ContextMenuIf
to be activated twicevoid handleProgramDoubleClick(Program program)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.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)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.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)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.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)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.Executes the middle click context menu action.
program
- The program to pass to the middle click context menu action.caller
- The ContextMenuIf that calls this. Prevents the ContextMenuIf
to be activated twice.void handleProgramMiddleDoubleClick(Program program)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.Executes the middle click context menu action. 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 action.void handleProgramMiddleDoubleClick(Program program, ContextMenuIf caller)
#ProgramMouseEventHandler
and/or #ProgramKeyEventHandler
instead.Executes the middle double click context menu action.
program
- The program to pass to the middle double click context menu action.caller
- ContextMenuIf that calls this. Prevents the ContextMenuIf to be activated twice.TvBrowserSettings getTvBrowserSettings()
javax.swing.ImageIcon getIconFromTheme(Plugin plugin, java.lang.String category, java.lang.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 Iconjavax.swing.ImageIcon getIconFromTheme(Plugin plugin, ThemeIcon icon)
plugin
- Plugin that wants to load an Iconicon
- Icon in the Icon-Themevoid showSettings(Plugin plugin)
plugin
- Use this Pluginvoid showSettings(java.lang.String settingsItem)
settingsItem
- SettingsItem to show (e.g. SettingsItem.CHANNELS)Program[] getMarkedPrograms()
ProgramReceiveIf[] getReceiveIfs()
ProgramReceiveIf[] getReceiveIfs(ProgramReceiveIf caller, ProgramReceiveTarget callerTarget)
caller
- The caller ProgramReceiveIf.callerTarget
- The target that calls the receive if array.ProgramReceiveIf getReceiceIfForId(java.lang.String id)
null
if there is
no ReceiveIf for the given id.id
- The id of the ReceiveIf.null
void scrollToProgram(Program program)
program
- The program to scroll to.void selectProgram(Program program)
program
- The program to select.void scrollToTime(int time)
time
- The time to scroll to in minutes.void scrollToTime(int time, boolean highlight)
time
- The time to scroll to in minutes after midnight.highlight
- If programs at scroll time should be highlighted (if scroll highlighting is enabled.)void scrollToChannel(Channel channel)
channel
- The channel to scroll to.void goToDate(Date date)
date
- The date to show the program for.FilterManager getFilterManager()
Don't use this method until TV-Browser is fully loaded.
null
if TV-Browser isn't fully loaded.AbstractPluginProgramFormating[] getAvailableGlobalPuginProgramFormatings()
Date getCurrentDate()
ProgramRatingIf[] getAllProgramRatingIfs()
void deleteFileOnNextStart(java.lang.String path)
path
- full file pathboolean isDataAvailable(Date date)
date
- true
if at least one channel has data for the dateboolean showBalloonTip(java.lang.String caption, java.lang.String message, java.awt.TrayIcon.MessageType messageType)
caption
- The caption of the displayed message.message
- The message to display in the balloon tip.messageType
- The java.awt.TrayIcon.MessageType of the displayed balllon tip.Version getTVBrowserVersion()
javax.swing.JPopupMenu createRemovedProgramContextMenu(Program program)
program
- The removed program to create the context menu forboolean isTvBrowserStartFinished()
true
if TV-Browser start was finished, false
otherwise.ProgressMonitorExtended createProgressMonitor()
TV-Browser 3.4.4, Copyright (C) 2004-2008 TV-Browser Team (dev@tvbrowser.org)