TV-Browser 2.7.5 API

devplugin
Interface TvBrowserSettings


public interface TvBrowserSettings

Provides information of the current user settings.


Method Summary
 short getAutoDownloadWaitingTime()
          Gets the time to wait for data automatically update.
 Color getColorForMarkingPriority(int priority)
          Gets the color for a marking priority.
 int getDefaultNetworkConnectionTimeout()
           
 Date getLastDownloadDate()
           
 Color getProgramPanelOnAirDarkColor()
          Gets the dark color of an on air program.
 Color getProgramPanelOnAirLightColor()
          Gets the light color of an on air program.
 int getProgramTableEndOfDay()
          Gets the end of day time of the program table.
 int getProgramTableStartOfDay()
          Gets the start of day time of the program table.
 int[] getTimeButtonTimes()
           
 String getTvBrowserUserHome()
           
 boolean isMarkingBorderPainted()
          Gets if the marking have a colored border.
 boolean isUsingExtraSpaceForMarkIcons()
          Gets if extra space for the plugin icons is used.
 

Method Detail

getTvBrowserUserHome

String getTvBrowserUserHome()
Returns:
the directory name of the user settings (e.g linux: ~/home/.tvbrowser/);

getTimeButtonTimes

int[] getTimeButtonTimes()
Returns:
the times of the time buttons (in minutes)

getLastDownloadDate

Date getLastDownloadDate()
Returns:
the date of the previous donwload

getDefaultNetworkConnectionTimeout

int getDefaultNetworkConnectionTimeout()
Returns:
The default network connection timeout
Since:
2.5.3

getColorForMarkingPriority

Color getColorForMarkingPriority(int priority)
Gets the color for a marking priority.

Parameters:
priority - The priority to get the color for.
Returns:
The color for the given priority or null if the given priority don't exists.
Since:
2.6

getProgramTableStartOfDay

int getProgramTableStartOfDay()
Gets the start of day time of the program table.

Returns:
start of day in minutes since midnight
Since:
2.6

getProgramTableEndOfDay

int getProgramTableEndOfDay()
Gets the end of day time of the program table.

Returns:
end of day in minutes since midnight
Since:
2.6

getProgramPanelOnAirLightColor

Color getProgramPanelOnAirLightColor()
Gets the light color of an on air program.

Returns:
The light color of an on air program.
Since:
2.6

getProgramPanelOnAirDarkColor

Color getProgramPanelOnAirDarkColor()
Gets the dark color of an on air program.

Returns:
The dark color of an on air program.
Since:
2.6

isMarkingBorderPainted

boolean isMarkingBorderPainted()
Gets if the marking have a colored border.

Returns:
True if the border is painted, false otherwise.
Since:
2.6

isUsingExtraSpaceForMarkIcons

boolean isUsingExtraSpaceForMarkIcons()
Gets if extra space for the plugin icons is used.

Returns:
True if extra space for the plugin icons is used, false otherwise.
Since:
2.6

getAutoDownloadWaitingTime

short getAutoDownloadWaitingTime()
Gets the time to wait for data automatically update.

Returns:
The time to wait before performing data update in seconds.
Since:
2.7.1

TV-Browser 2.7.5 API

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