Package net.i2p.desktopgui

Class Main

java.lang.Object

net.i2p.desktopgui.Main

All Implemented Interfaces:

ClientApp, MenuService, NotificationService, RouterApp

public class Main
extends Object
implements RouterApp, NotificationService, MenuService

The main class of the application.

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROP_ENABLE

Constructor Summary

Constructors

Constructor	Description
Main()
Main(RouterContext ctx, ClientAppManager mgr, String[] args)

Method Summary

Modifier and Type	Method	Description
MenuHandle	addMenu(String message, MenuCallback callback)	Menu will start out shown and enabled, in the root menu
MenuHandle	addMenu(String message, MenuCallback callback, MenuHandle parent)	Menu will start out enabled, as a submenu
boolean	cancel(int id)	Cancel a notification if possible.
void	disableMenu(MenuHandle item)
void	enableMenu(MenuHandle item)
String	getDisplayName()	The display name of the ClientApp, used in user interfaces.
String	getName()	The generic name of the ClientApp, used for registration, e.g.
ClientAppState	getState()	The current state of the ClientApp.
void	hideMenu(MenuHandle item)
static void	main(String[] args)
int	notify(String source, String category, int priority, String title, String message, String path)	Send a notification to the user.
void	removeMenu(MenuHandle item)
void	showMenu(MenuHandle item)
void	shutdown(String[] args)	Do not take a long time.
void	startup()	Do not take a long time.
boolean	update(int id, String title, String message, String path)	Update the text of a notification if possible.
void	updateMenu(String message, MenuHandle item)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROP_ENABLE

public static final String PROP_ENABLE

See Also:

Constant Field Values

Constructor Detail

Main

public Main(RouterContext ctx,
            ClientAppManager mgr,
            String[] args)

Since:

0.9.26

Main

public Main()

Since:

0.9.26

Method Detail

main

public static void main(String[] args)

notify

public int notify(String source,
                  String category,
                  int priority,
                  String title,
                  String message,
                  String path)

Send a notification to the user.

Specified by:

notify in interface NotificationService

Parameters:

source - unsupported

category - unsupported

priority - unsupported

title - for the popup, translated

message - translated

path - unsupported

Returns:

0, or -1 on failure

cancel

public boolean cancel(int id)

Cancel a notification if possible. Unsupported.

Specified by:

cancel in interface NotificationService

Parameters:

id - as received from notify()

Returns:

false always

update

public boolean update(int id,
                      String title,
                      String message,
                      String path)

Update the text of a notification if possible. Unsupported.

Specified by:

update in interface NotificationService

Parameters:

id - as received from notify()

title - for the popup, translated

message - translated

path - in console starting with /, must be URL-escaped, or null

Returns:

false always

addMenu

public MenuHandle addMenu(String message,
                          MenuCallback callback)

Menu will start out shown and enabled, in the root menu

Specified by:

addMenu in interface MenuService

Parameters:

message - for the menu, translated

callback - fired on click

Returns:

null on error

Since:

0.9.59

addMenu

public MenuHandle addMenu(String message,
                          MenuCallback callback,
                          MenuHandle parent)

Menu will start out enabled, as a submenu

Specified by:

addMenu in interface MenuService

Parameters:

message - for the menu, translated

callback - fired on click

parent - the parent menu this will be a submenu of, or null for top level

Returns:

null on error

Since:

0.9.59

removeMenu

public void removeMenu(MenuHandle item)

Specified by:

removeMenu in interface MenuService

Since:

0.9.59

showMenu

public void showMenu(MenuHandle item)

Specified by:

showMenu in interface MenuService

Since:

0.9.59

hideMenu

public void hideMenu(MenuHandle item)

Specified by:

hideMenu in interface MenuService

Since:

0.9.59

enableMenu

public void enableMenu(MenuHandle item)

Specified by:

enableMenu in interface MenuService

Since:

0.9.59

disableMenu

public void disableMenu(MenuHandle item)

Specified by:

disableMenu in interface MenuService

Since:

0.9.59

updateMenu

public void updateMenu(String message,
                       MenuHandle item)

Specified by:

updateMenu in interface MenuService

Since:

0.9.59

startup

public void startup()

Description copied from interface: ClientApp

Do not take a long time. Do not block. Start threads here if necessary. Client must call ClientAppManager.notify() at least once within this method to change the state from INITIALIZED to something else. Will not be called multiple times on the same object.

Specified by:

startup in interface ClientApp

Since:

0.9.26

shutdown

public void shutdown(String[] args)

Description copied from interface: ClientApp

Do not take a long time. Do not block. Use a thread if necessary. If previously running, client must call ClientAppManager.notify() at least once within this method to change the state to STOPPING or STOPPED. May be called multiple times on the same object, in any state.

Specified by:

shutdown in interface ClientApp

Parameters:

args - generally null but could be stopArgs from clients.config

Since:

0.9.26

getState

public ClientAppState getState()

Description copied from interface: ClientApp

The current state of the ClientApp.

Specified by:

getState in interface ClientApp

Returns:

non-null

Since:

0.9.26

getName

public String getName()

Description copied from interface: ClientApp

The generic name of the ClientApp, used for registration, e.g. "console". Do not translate.

Specified by:

getName in interface ClientApp

Returns:

non-null

Since:

0.9.26

getDisplayName

public String getDisplayName()

Description copied from interface: ClientApp

The display name of the ClientApp, used in user interfaces. The app must translate.

Specified by:

getDisplayName in interface ClientApp

Returns:

non-null

Since:

0.9.26