com.ontimize.util.gis.client.interfaces
Interface IOGisComponent

All Known Implementing Classes:

OGisComponent

public interface IOGisComponent

Main gis component interface. The code to get a reference for this component from the form interaction manager is:

protected IOGisComponent gisComponent = null; 
 ***
 Object obj = managedForm.getDataFieldReference("gisComponentAttr");
 if(obj != null && obj instanceof IOGisComponent) {
     gisComponent = ((IOGisComponent) obj);
 }

Method Summary

int	addComponentToLayeredPane(java.awt.Component comp) Add a new component to the gis layered panel
int	addComponentToLayeredPane(java.awt.Component comp, int index) Add a new component to the gis layered panel, indicating the index of the component inside the layered panel
java.lang.Object	getAttribute() Get gis component "attr" parameter
java.awt.Rectangle	getBounds() Get the gis component bounds
java.lang.Object	getFormFieldValue(java.lang.String formFieldName) Gets a form field value.
com.ontimize.gui.Form	getFormReference() Get the gis component form reference
java.lang.Object	getGisViewer() Get a reference to the gis map component
java.util.List<javax.swing.JComponent>	getLayerPaneComponents() Get the list of components added into the OntimizeGis component layered panel
java.util.ResourceBundle	getResourceBundle()
void	loadingFinished() Internal use method
void	registerKeyListener(java.awt.event.KeyListener listener) Register a new key events listener on the gis component
void	reloadComponent() Initilializes the Gis component, forcing it to request the layers configuration data again
void	removeComponentFromLayeredPane(java.awt.Component comp) Remove the given component from the gis component layered panel
void	setCursor(java.awt.Cursor cursor) Changes the actual gis component cursor
void	setLoadingMessage(java.lang.String message) Set the actual message of the loading panel
void	unRegisterKeyListener(java.awt.event.KeyListener listener) Delete the key events listener from the gis component key listeners group

Method Detail

getGisViewer

java.lang.Object getGisViewer()

Get a reference to the gis map component

Returns:

gis map component reference

loadingFinished

void loadingFinished()

Internal use method

registerKeyListener

void registerKeyListener(java.awt.event.KeyListener listener)

Register a new key events listener on the gis component

Parameters:

listener - Key listener to register

unRegisterKeyListener

void unRegisterKeyListener(java.awt.event.KeyListener listener)

Delete the key events listener from the gis component key listeners group

Parameters:

listener - Key listener to delete

getAttribute

java.lang.Object getAttribute()

Get gis component "attr" parameter

Returns:

Attribute

addComponentToLayeredPane

int addComponentToLayeredPane(java.awt.Component comp)

Add a new component to the gis layered panel

Parameters:

comp - Component to add

Returns:

Component panel layer index

addComponentToLayeredPane

int addComponentToLayeredPane(java.awt.Component comp,
                              int index)

Add a new component to the gis layered panel, indicating the index of the component inside the layered panel

Parameters:

comp - Component to add

index - Component panel layer index

Returns:

Component panel layer index

removeComponentFromLayeredPane

void removeComponentFromLayeredPane(java.awt.Component comp)

Remove the given component from the gis component layered panel

Parameters:

comp - Component to remove

getLayerPaneComponents

java.util.List<javax.swing.JComponent> getLayerPaneComponents()

Get the list of components added into the OntimizeGis component layered panel

Returns:

Components list

setCursor

void setCursor(java.awt.Cursor cursor)

Changes the actual gis component cursor

Parameters:

cursor - Gis component cursor

getFormFieldValue

java.lang.Object getFormFieldValue(java.lang.String formFieldName)

Gets a form field value. This method is usually used by gis components with no access to the interaction manager

Parameters:

formFieldName - Form field name

Returns:

Form value

getBounds

java.awt.Rectangle getBounds()

Get the gis component bounds

Returns:

Gis component bounds

setLoadingMessage

void setLoadingMessage(java.lang.String message)

Set the actual message of the loading panel

Parameters:

message - Loading panel message

getFormReference

com.ontimize.gui.Form getFormReference()

Get the gis component form reference

Returns:

form reference

reloadComponent

void reloadComponent()

Initilializes the Gis component, forcing it to request the layers configuration data again

getResourceBundle

java.util.ResourceBundle getResourceBundle()