de.cismet.cismap.commons.gui.featureinfowidget

Interface FeatureInfoDisplay<T>

All Known Implementing Classes:

AbstractFeatureInfoDisplay, OGCWMSGetFeatureInfoRequestHtmlDisplay

public interface FeatureInfoDisplay<T>

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

thorsten.hell@cismet.de, martin.scholl@cismet.de

Method Summary

Modifier and Type	Method and Description
JComponent	getDisplayComponent() Retrieves the component that is responsible for displaying any results of calls to showFeatureInfo.
FeatureInfoDisplayKey	getDisplayKey() Retrieves the FeatureInfoDisplayKey information that determines which layer implementation class this instance accepts and which server and layer it will be responsible for.
void	init(T layer, JTabbedPane parentTabbedPane) This operation shall be called before the application sends MapClickedEvents to the FeatureInfoDisplay.
void	showFeatureInfo(MapClickedEvent mce) Processes the MapClickedEvent and most likely somehow display information within the display component.

Method Detail

init

void init(T layer,
          JTabbedPane parentTabbedPane)
   throws InitialisationException

This operation shall be called before the application sends MapClickedEvents to the FeatureInfoDisplay. It shall be used to provide necessary information to the FeatureInfoDisplay so that it can serve its purpose in displaying feature information for certain points.

Parameters:

layer - The layer object that will use this FeatureInfoDisplay

parentTabbedPane - the parent component of the display

Throws:

InitialisationException - if any error occurs during initialisation

showFeatureInfo

void showFeatureInfo(MapClickedEvent mce)

Processes the MapClickedEvent and most likely somehow display information within the display component.

Parameters:

mce - the MapClickedEvent to process

See Also:

getDisplayComponent()

getDisplayComponent

JComponent getDisplayComponent()

Retrieves the component that is responsible for displaying any results of calls to showFeatureInfo.

Returns:

the displaying component

See Also:

showFeatureInfo(de.cismet.cismap.commons.interaction.events.MapClickedEvent)

getDisplayKey

FeatureInfoDisplayKey getDisplayKey()

Retrieves the FeatureInfoDisplayKey information that determines which layer implementation class this instance accepts and which server and layer it will be responsible for.

Returns:

the FeatureInfoDisplayKey