org.eclipse.equinox.app
Interface IApplicationContext
-
public interface IApplicationContext
The context used to start an application.
This interface is not intended to be implemented by clients.
-
Since:
- 1.0
-
Restriction:
- This interface is not intended to be implemented by clients.
-
Restriction:
- This interface is not intended to be extended by clients.
APPLICATION_ARGS
static final
String APPLICATION_ARGS
- A key used to store arguments for the application. The content of this argument
is unchecked and should conform to the expectations of the application being invoked.
Typically this is a
String
array.
If the map used to launch an application
ApplicationDescriptor.launch(Map)
does
not contain a value for this key then command line arguments used to launch
the platform are set in the arguments of the application context.
-
See Also:
-
Constant Field Values
getArguments
Map getArguments()
- The arguments used for the application. The arguments from
ApplicationDescriptor.launch(Map)
are used as the arguments
for this context when an application is launched.
-
-
Returns:
- a map of application arguments.
applicationRunning
void applicationRunning()
- This method should be called once the application is completely initialized and running.
This method will perform certain operations that are needed once an application is running.
One example is bringing down a splash screen if it exists.
-
getBrandingApplication
String getBrandingApplication()
- Returns the application associated with this application context. This information
is used to guide the runtime as to what application extension to create and execute.
-
-
Returns:
- this product's application or
null
if none
getBrandingName
String getBrandingName()
- Returns the name of the product associated with this application context.
The name is typically used in the title bar of UI windows.
-
-
Returns:
- the name of the product or
null
if none
getBrandingDescription
String getBrandingDescription()
- Returns the text description of the product associated with this application context.
-
-
Returns:
- the description of the product or
null
if none
getBrandingId
String getBrandingId()
- Returns the unique product id of the product associated with this application context.
-
-
Returns:
- the id of the product
getBrandingProperty
String getBrandingProperty(
String key)
- Returns the property with the given key of the product associated with this application context.
null
is returned if there is no such key/value pair.
-
-
Parameters:
-
key
- the name of the property to return
-
Returns:
- the value associated with the given key or
null
if none
getBrandingBundle
Bundle getBrandingBundle()
- Returns the bundle which is responsible for the definition of the product associated with
this application context.
Typically this is used as a base for searching for images and other files
that are needed in presenting the product.
-
-
Returns:
- the bundle which defines the product or
null
if none
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.