TV-Browser 2.7.5 API

tvbrowser.core.filters
Interface FilterComponent

All Known Implementing Classes:
BeanShellFilterComponent, ChannelFilterComponent, DayFilterComponent, FavoritesFilterComponent, KeywordFilterComponent, MarkListFilterComponent, MassFilterComponent, PluginFilterComponent, PluginIconFilterComponent, PluginsFilterComponent, ProgramInfoFilterComponent, ProgramLengthFilterComponent, ProgramMarkingPriorityFilterComponent, ProgramRunningFilterComponent, ReminderFilterComponent, TimeFilterComponent, TVRaterFilter

public interface FilterComponent

An interface for the program filter system of TV-Browser.


Nested Class Summary
static class FilterComponent.NameComparator
          comparator for filter components (comparing by name)
static class FilterComponent.TypeComparator
          comparator for filter components (comparing by string representation)
 
Method Summary
 boolean accept(Program program)
          Checks a program if it is acceptable by the FilterComponent.
 String getDescription()
          Gets the description of a FilterComponent.
 String getName()
          Gets the name of a FilterComponent.
 JPanel getSettingsPanel()
          Gets the settings panel for a FilterComponent.
 int getVersion()
          Gets the version number of a FilterComponent.
 void read(ObjectInputStream in, int version)
          Loads the settings of a FilterComponent from an ObjectInputStream.
 void saveSettings()
          Is called when the settings should be saved (aka the users pressed the OK-Button in the Settings Dialog)
 void setDescription(String desc)
          Sets the description of a FilterComponent.
 void setName(String name)
          Sets the name of a FilterComponent.
 void write(ObjectOutputStream out)
          Saves the settings of a FilterComponent to an ObjectOutputStream.
 

Method Detail

getVersion

int getVersion()
Gets the version number of a FilterComponent.

Returns:
The version number of a FilterComponent.

accept

boolean accept(Program program)
Checks a program if it is acceptable by the FilterComponent.

Parameters:
program - The program to check.
Returns:
true if the program is acceptable by the FilterComponent, false otherwise.

read

void read(ObjectInputStream in,
          int version)
          throws IOException,
                 ClassNotFoundException
Loads the settings of a FilterComponent from an ObjectInputStream.

Parameters:
in - The stream to read from.
version - The version of the data.
Throws:
IOException
ClassNotFoundException

write

void write(ObjectOutputStream out)
           throws IOException
Saves the settings of a FilterComponent to an ObjectOutputStream.

Parameters:
out - The stream to write to.
Throws:
IOException

getSettingsPanel

JPanel getSettingsPanel()
Gets the settings panel for a FilterComponent.

Returns:
The settings panel the FilterComponent.

saveSettings

void saveSettings()
Is called when the settings should be saved (aka the users pressed the OK-Button in the Settings Dialog)


getName

String getName()
Gets the name of a FilterComponent.

Returns:
The name of the FilterComponent.

getDescription

String getDescription()
Gets the description of a FilterComponent.

Returns:
The description of the FilterComponent.

setName

void setName(String name)
Sets the name of a FilterComponent.

Parameters:
name - The new name of the FilterComponent.

setDescription

void setDescription(String desc)
Sets the description of a FilterComponent.

Parameters:
desc - The new description of the FilterComponent.

TV-Browser 2.7.5 API

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