org.gvsig.app.gui

Class WizardPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gvsig.app.gui.WizardPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

Direct Known Subclasses:

AbstractWizardDB, AddOSMLayerWizard, AddPostGISRasterLayerWizard, AddWebMapLayerWizard, FileOpenWizard, FilesystemExplorerWizardPanel, GPXWizard, OGRWizarPanel, SeismicDriverWizard, WCSParamsPanel, WCSWizard, WFSWizard, WMSParamsPanel, WMSWizard, WMTSWizard

public abstract class WizardPanel
extends javax.swing.JPanel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected Arguments	arguments

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
WizardPanel()

Method Summary

Modifier and Type	Method and Description
boolean	addArguments(Arguments args)
protected void	addTask(java.lang.Thread task)
void	addWizardListener(WizardListener listener)
boolean	areSettingsValid() This method is called for example when user changes tab in add layer dialog (new tab's settings are valid?)
void	callError(java.lang.Exception descripcion)
void	callStateChanged(boolean finishable)
protected void	clearTasks()
abstract void	close()
protected void	doAddLayer(MapControl mapControl, java.lang.String layerName, DataStoreParameters parameters) Deprecated. Use doAddLayer(String, DataStoreParameters) in combination with setMapCtrl(MapControl) if you need to set the MapControl. Note that MapControl is automatically initialized when creating the panel from the AddLayer extension.
protected void	doAddLayer(java.lang.String layerName, DataStoreParameters parameters)
abstract void	execute() Deprecated. use executeWizard() instead.
java.lang.Object	executeWizard() Executes the wizard and returns anything created in the process.
protected void	fixCRS(DataStoreParameters params)
MapContext	getMapContext() You can use it to extract information from the MapContext that will receive the new layer.
MapControl	getMapCtrl() You can use it to interact with the MapControl component that will receive the new layer, in order to get user feedback (for instance a bounding box).
abstract DataStoreParameters[]	getParameters()
java.lang.String	getTabName()
abstract void	initWizard()
boolean	isMapControlAvailable() Checks whether the MapControl is available.
void	removeWizardListener(WizardListener listener)
void	setMapContext(MapContext mapContext) Sets the MapContext that will receive the new layer
void	setMapCtrl(MapControl mapCtrl) Sets the MapControl that will receive the new layer
protected void	setTabName(java.lang.String name)
protected void	startTask(java.lang.Thread task)
void	waitTasks(long timeoutms)

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

arguments

protected Arguments arguments

Constructor Detail

WizardPanel

public WizardPanel()

Method Detail

addWizardListener

public void addWizardListener(WizardListener listener)

callError

public void callError(java.lang.Exception descripcion)

removeWizardListener

public void removeWizardListener(WizardListener listener)

callStateChanged

public void callStateChanged(boolean finishable)

setTabName

protected void setTabName(java.lang.String name)

getTabName

public java.lang.String getTabName()

initWizard

public abstract void initWizard()

execute

public abstract void execute()

Deprecated. use executeWizard() instead.

executeWizard

public java.lang.Object executeWizard()

Executes the wizard and returns anything created in the process.

Returns:

anything created in the process

close

public abstract void close()

getParameters

public abstract DataStoreParameters[] getParameters()

getMapCtrl

public MapControl getMapCtrl()

You can use it to interact with the MapControl component that will receive the new layer, in order to get user feedback (for instance a bounding box). Check the isMapControlAvailable() method before accessing the MapControl because it may not be available (for instance when adding layers to a MapContext not associated with a View). For the moment, this method will return a non-null MapControl for compatibility reasons, but you should still check isMapControlAvailable() to be sure it is a valid one, as it could only be a fake MapControl. It is recommended to use getMapContext() method when no interaction is needed with the map user interface (for instance to get the active projection, visible extent, etc)

Returns:

Returns the mapCtrl.

setMapCtrl

public void setMapCtrl(MapControl mapCtrl)

Sets the MapControl that will receive the new layer

Parameters:

mapCtrl - The mapCtrl to set.

getMapContext

public MapContext getMapContext()

You can use it to extract information from the MapContext that will receive the new layer. For example, projection to use, or visible extent.

Returns:

Returns the MapContext.

setMapContext

public void setMapContext(MapContext mapContext)

Sets the MapContext that will receive the new layer

Parameters:

mapContext - The mapContext to set.

isMapControlAvailable

public boolean isMapControlAvailable()

Checks whether the MapControl is available. The MapControl may not be available in some circumstances, for instance when adding layers to a MapContext not associated with a View. A MapContext should always be available on the getMapContext() method.

Returns:

true if the MapControl is available, false otherwise

doAddLayer

protected void doAddLayer(java.lang.String layerName,
                          DataStoreParameters parameters)

doAddLayer

protected void doAddLayer(MapControl mapControl,
                          java.lang.String layerName,
                          DataStoreParameters parameters)

Deprecated. Use doAddLayer(String, DataStoreParameters) in combination with setMapCtrl(MapControl) if you need to set the MapControl. Note that MapControl is automatically initialized when creating the panel from the AddLayer extension.

Parameters:

mapControl -

layerName -

parameters -

areSettingsValid

public boolean areSettingsValid()

This method is called for example when user changes tab in add layer dialog (new tab's settings are valid?)

Returns:

whether current wizard settings are enough (for example, to enable an Accept button in a container)

fixCRS

protected void fixCRS(DataStoreParameters params)

addArguments

public boolean addArguments(Arguments args)

addTask

protected void addTask(java.lang.Thread task)

startTask

protected void startTask(java.lang.Thread task)

clearTasks

protected void clearTasks()

waitTasks

public void waitTasks(long timeoutms)