JMapApplication (JMap 7.0 Kathmandu API Documentation)

java.lang.Object
- com.kheops.jmap.client.application.JMapApplication

All Implemented Interfaces:: ProjectEventListener

public abstract class JMapApplication
extends java.lang.Object
implements ProjectEventListener

Field Summary

Fields
Modifier and Type	Field and Description
`protected Project`	`currentProject`
`protected SharedLayerManager`	`sharedLayerManager`
`static java.lang.String`	`USER_PARAM_APPLICATION_OVERVIEW_VISIBLE`
`static java.lang.String`	`USER_PARAM_APPLICATION_STATUSBAR_VISIBLE`
`static java.lang.String`	`USER_PARAM_LAST_BROWSED_DIRECTORY`
`static java.lang.String`	`USER_PARAM_MOUSE_OVER_DISPLAY_DELAY`
`static java.lang.String`	`USER_PARAM_PRINT_SETTINGS`
`static java.lang.String`	`USER_PARAM_QUERY_PANEL_OPTIONS`

Constructor Summary

Constructors
Constructor and Description

JMapApplication()

Constructors
Constructor and Description
`JMapApplication()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addProjectListener(ProjectEventListener listener)` Adds a new project listener.
`void`	`closeProject()` Closes the current opened project.
`View`	`createNewView()` Creates a new view with the default view settings and adds it to the view manager.
`View`	`createNewView(JMapContext context)` Deprecated.
`View`	`createNewView(MapContextInfo context)` Creates a new view and adds it to the view manager.
`JMapClientExtension`	`getClientExtension(java.lang.String className)` Returns the instance of the client extension which matches the specified full class name.
`Project`	`getCurrentProject()` Returns the current open project.
`DefaultEditionEventDispatcher`	`getDefaultEditionEventDispatcher()` Returns the default edition event dispatcher.
`EditionTransactionManager`	`getEditionController()` Deprecated. use `getEditionTransactionManager()` instead.
`EditionTransactionManager`	`getEditionTransactionManager()` Returns the main instance of the edition transaction manager.
`JMapClientExtension[]`	`getExtensions()` Returns all client extensions loaded by this application.
`java.util.Properties`	`getFeaturesList()`
`abstract JMapGuiService`	`getGuiService()` Returns the GUI application service.
`protected java.lang.String`	`getJMapExtensionManifestValue(java.lang.Class<?> extensionClass, java.lang.String manifestAttributeName)`
`protected java.lang.String`	`getJMapExtensionVersion(java.lang.Class<?> extensionClass)`
`java.lang.String`	`getJMapVersion()` Returns the JMap build version contained in the MANIFEST file.
`java.util.logging.Logger`	`getLogger()` Deprecated. use `Logger.getInstance()`
`JMapClientMessagingController`	`getMessagingController()`
`SplashLoginWindow`	`getSplashLoginWindow()` Returns the Splash window.
`UserParameter`	`getUserParameter(java.lang.String parameterKey)` Returns the user parameter that was set for the specified parameter key.
`JMapUserParameterController`	`getUserParameterController()`
`abstract void`	`initGui()` Initializes all GUI (Graphical User Interface) components.
`boolean`	`isFeatureAvailable(java.lang.String featureName)`
`protected void`	`openProject(java.lang.String projectName)`
`boolean`	`openSession(boolean showLoginDialog)`
`void`	`openUrl(java.lang.String jsFunction, java.lang.String url, boolean addLocaleParams)` Open an URL.
`void`	`projectClosed(ProjectEvent event)` This method is called when a project is closed.
`void`	`projectOpened(ProjectEvent event)` This method is called when a project is opened and ready.
`void`	`removeProjectListener(ProjectEventListener listener)` Removes a project listener.
`void`	`setUserParameter(UserParameter userParameter)` Sets the specified user parameter.
`void`	`shutdown()` Shutdowns the application.
`void`	`startup(JMapApplicationContext appContext)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - USER_PARAM_MOUSE_OVER_DISPLAY_DELAY
```
public static final java.lang.String USER_PARAM_MOUSE_OVER_DISPLAY_DELAY
```
    See Also:
    
    Constant Field Values
  - USER_PARAM_APPLICATION_STATUSBAR_VISIBLE
```
public static final java.lang.String USER_PARAM_APPLICATION_STATUSBAR_VISIBLE
```
    See Also:
    
    Constant Field Values
  - USER_PARAM_APPLICATION_OVERVIEW_VISIBLE
```
public static final java.lang.String USER_PARAM_APPLICATION_OVERVIEW_VISIBLE
```
    See Also:
    
    Constant Field Values
  - USER_PARAM_QUERY_PANEL_OPTIONS
```
public static final java.lang.String USER_PARAM_QUERY_PANEL_OPTIONS
```
    See Also:
    
    Constant Field Values
  - USER_PARAM_PRINT_SETTINGS
```
public static final java.lang.String USER_PARAM_PRINT_SETTINGS
```
    See Also:
    
    Constant Field Values
  - USER_PARAM_LAST_BROWSED_DIRECTORY
```
public static final java.lang.String USER_PARAM_LAST_BROWSED_DIRECTORY
```
    See Also:
    
    Constant Field Values
  - currentProject
```
protected Project currentProject
```
  - sharedLayerManager
```
protected SharedLayerManager sharedLayerManager
```
- Constructor Detail
  - JMapApplication
```
public JMapApplication()
```
- Method Detail
  - startup
```
public void startup(JMapApplicationContext appContext)
```
  - getLogger
```
@Deprecated
public final java.util.logging.Logger getLogger()
```
    Deprecated. use Logger.getInstance()
    
    Returns the application logger.
    
    Returns:
    
    the logger
    
    See Also:
    
    Logger
  - getMessagingController
```
public JMapClientMessagingController getMessagingController()
```
  - getEditionController
```
@Deprecated
public EditionTransactionManager getEditionController()
```
    Deprecated. use getEditionTransactionManager() instead.
    
    Returns the main instance of the edition transaction manager.
    
    Returns:
    
    the main edition transaction manager instance.
  - getEditionTransactionManager
```
public EditionTransactionManager getEditionTransactionManager()
```
    Returns the main instance of the edition transaction manager.
    
    Returns:
    
    the main edition transaction manager instance.
  - getDefaultEditionEventDispatcher
```
public DefaultEditionEventDispatcher getDefaultEditionEventDispatcher()
```
    Returns the default edition event dispatcher.
    
    Returns:
    
    the default edition event dispatcher.
  - getUserParameterController
```
public JMapUserParameterController getUserParameterController()
```
  - openSession
```
public boolean openSession(boolean showLoginDialog)
```
  - openProject
```
protected void openProject(java.lang.String projectName)
```
  - getFeaturesList
```
public java.util.Properties getFeaturesList()
```
  - isFeatureAvailable
```
public boolean isFeatureAvailable(java.lang.String featureName)
```
    Parameters:
    
    featureName - the feature key in the features list
    
    Returns:
    
    true if the feature is available
  - getCurrentProject
```
public Project getCurrentProject()
```
    Returns the current open project.
    
    Returns:
    
    the current open project or null if none is open
  - closeProject
```
public void closeProject()
```
    Closes the current opened project.
  - createNewView
```
public View createNewView()
```
    Creates a new view with the default view settings and adds it to the view manager. null is returned if a project is not opened.
    
    Returns:
    
    the new view
    
    See Also:
    
    ViewManager, ViewSettings
  - createNewView
```
@Deprecated
public View createNewView(JMapContext context)
```
    Deprecated.
    
    Creates a new view and adds it to the view manager. If context is null, the new new will be created with the default view settings. null is returned if a project is not opened.
    
    Parameters:
    
    context -
    
    Returns:
    
    the new view
    
    See Also:
    
    ViewManager, ViewSettings
  - createNewView
```
public View createNewView(MapContextInfo context)
```
    Creates a new view and adds it to the view manager. If context is null, the new new will be created with the default view settings. null is returned if a project is not opened.
    
    Parameters:
    
    context -
    
    Returns:
    
    the new view
    
    See Also:
    
    ViewManager, ViewSettings
  - projectOpened
```
public void projectOpened(ProjectEvent event)
```
    Description copied from interface: ProjectEventListener
    
    This method is called when a project is opened and ready.
    
    Specified by:
    
    projectOpened in interface ProjectEventListener
    
    Parameters:
    
    event - the project event
    
    See Also:
    
    ProjectEvent
  - projectClosed
```
public void projectClosed(ProjectEvent event)
```
    Description copied from interface: ProjectEventListener
    
    This method is called when a project is closed.
    
    Specified by:
    
    projectClosed in interface ProjectEventListener
    
    Parameters:
    
    event - the project event
    
    See Also:
    
    ProjectEvent
  - addProjectListener
```
public void addProjectListener(ProjectEventListener listener)
```
    Adds a new project listener.
    
    Parameters:
    
    listener - the new listener
  - removeProjectListener
```
public void removeProjectListener(ProjectEventListener listener)
```
    Removes a project listener.
    
    Parameters:
    
    listener - the listener to remove
  - shutdown
```
public void shutdown()
```
    Shutdowns the application.
  - openUrl
```
public void openUrl(java.lang.String jsFunction,
                    java.lang.String url,
                    boolean addLocaleParams)
             throws java.lang.Exception
```
    Open an URL.
    
    Parameters:
    
    jsFunction - the JavaScript function name to use if the application is not running standalone
    
    url - the URL to execute
    
    addLocaleParams - if true, the Locale params will be added to the URL (&locale_lang=xx&locale_cntr=xx)
    
    Throws:
    
    java.lang.Exception
  - getSplashLoginWindow
```
public SplashLoginWindow getSplashLoginWindow()
```
    Returns the Splash window. The splash is available during the initialization. null will be returned otherwise.
    
    Returns:
    
    current splash window
  - getJMapVersion
```
public final java.lang.String getJMapVersion()
```
    Returns the JMap build version contained in the MANIFEST file.
    
    Returns:
    
    the JMap version
  - getClientExtension
```
public JMapClientExtension getClientExtension(java.lang.String className)
```
    Returns the instance of the client extension which matches the specified full class name.
    
    Parameters:
    
    className - the class name of the client extension
    
    Returns:
    
    the instance of the client extension or null if the class name was not found.
  - getExtensions
```
public JMapClientExtension[] getExtensions()
```
    Returns all client extensions loaded by this application.
    
    Returns:
    
    all client extensions loaded by this application.
  - getJMapExtensionManifestValue
```
protected final java.lang.String getJMapExtensionManifestValue(java.lang.Class<?> extensionClass,
                                                               java.lang.String manifestAttributeName)
```
  - getJMapExtensionVersion
```
protected final java.lang.String getJMapExtensionVersion(java.lang.Class<?> extensionClass)
```
  - getUserParameter
```
public UserParameter getUserParameter(java.lang.String parameterKey)
```
    Returns the user parameter that was set for the specified parameter key.
    
    Parameters:
    
    parameterKey - the parameter key used to retrieve the user parameter.
    
    Returns:
    
    the user parameter defined for the specified parameter key, or null if not defined.
    
    See Also:
    
    JMapUserParameterController.getUserParameter(String)
  - setUserParameter
```
public void setUserParameter(UserParameter userParameter)
```
    Sets the specified user parameter.
    
    Parameters:
    
    userParameter - the user parameter to set.
    
    See Also:
    
    JMapUserParameterController.setUserParameter(UserParameter)
  - getGuiService
```
public abstract JMapGuiService getGuiService()
```
    Returns the GUI application service. This service is used to add / remove components in the application.
    
    Returns:
    
    the GUI application service
  - initGui
```
public abstract void initGui()
```
    Initializes all GUI (Graphical User Interface) components.

Class JMapApplication

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

USER_PARAM_MOUSE_OVER_DISPLAY_DELAY

USER_PARAM_APPLICATION_STATUSBAR_VISIBLE

USER_PARAM_APPLICATION_OVERVIEW_VISIBLE

USER_PARAM_QUERY_PANEL_OPTIONS

USER_PARAM_PRINT_SETTINGS

USER_PARAM_LAST_BROWSED_DIRECTORY

currentProject

sharedLayerManager

Constructor Detail

JMapApplication

Method Detail

startup

getLogger

getMessagingController

getEditionController

getEditionTransactionManager

getDefaultEditionEventDispatcher

getUserParameterController

openSession

openProject

getFeaturesList

isFeatureAvailable

getCurrentProject

closeProject

createNewView

createNewView

createNewView

projectOpened

projectClosed

addProjectListener

removeProjectListener

shutdown

openUrl

getSplashLoginWindow

getJMapVersion

getClientExtension

getExtensions

getJMapExtensionManifestValue

getJMapExtensionVersion

getUserParameter

setUserParameter

getGuiService

initGui