Package org.geotools.swing.data

Class JParameterListWizard

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants
    public class JParameterListWizard
extends JWizard
    Wizard prompting the user to enter or review connection parameters.

    Example of use (from the GeoTools example project): 

    
 List<Parameter<?>> list = new ArrayList<Parameter<?>>();
 list.add(new Parameter<File>("image", File.class, "Image",
 "GeoTiff or World+Image to display as basemap",
 new KVP( Parameter.EXT, "tif", Parameter.EXT, "jpg")));
 list.add(new Parameter<File>("shape", File.class, "Shapefile",
 "Shapefile contents to display", new KVP(Parameter.EXT, "shp")));

 JParameterListWizard wizard = new JParameterListWizard("Image Lab",
 "Fill in the following layers", list);
 int finish = wizard.showModalDialog();

 if (finish != JWizard.FINISH) {
 System.exit(0);
 }
 File imageFile = (File) wizard.getConnectionParameters().get("image");
 File shapeFile = (File) wizard.getConnectionParameters().get("shape");
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class JDialog

        JDialog.AccessibleJDialog

      • Nested classes/interfaces inherited from class Dialog

        Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityType

      • Nested classes/interfaces inherited from class Window

        Window.AccessibleAWTWindow, Window.Type

      • Nested classes/interfaces inherited from class Container

        Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class Component

        Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Map<String,​Object> connectionParameters
      Connection parameters; shared with pages for editing

      • Fields inherited from class JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled

      • Fields inherited from class Dialog

        DEFAULT_MODALITY_TYPE

      • Fields inherited from class Component

        BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface ImageObserver

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

      • Fields inherited from interface WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

    • Constructor Summary

      Constructors 
      Constructor Description
      JParameterListWizard​(String title, String description, List<Parameter<?>> contents)
      Constructor.
      JParameterListWizard​(String title, String description, List<Parameter<?>> contents, Map<String,​Object> connectionParams)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Map<String,​Object> getConnectionParameters()
      Retrieve the connection parameters entered
      File getFile()
      Helper method that returns the "url" element of the connection parameters as a File, if present.

      • Methods inherited from class JDialog

        addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

      • Methods inherited from class Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack

      • Methods inherited from class Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront

      • Methods inherited from class Container

        add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class Object

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

    • Field Detail

      • connectionParameters

        protected Map<String,​Object> connectionParameters
        Connection parameters; shared with pages for editing

    • Constructor Detail

      • JParameterListWizard

        public JParameterListWizard​(String title,
                            String description,
                            List<Parameter<?>> contents,
                            Map<String,​Object> connectionParams)
        Constructor.
        Parameters:
        title - title for the dialog
        description - brief description to be displayed on the page
        contents - a List of Parameter objects defining the data being requested
        connectionParams - an optional Map of initial parameter values

      • JParameterListWizard

        public JParameterListWizard​(String title,
                            String description,
                            List<Parameter<?>> contents)
        Constructor.
        Parameters:
        title - title for the dialog
        description - brief description to be displayed on the page
        contents - a List of Parameter objects defining the data being requested

    • Method Detail

      • getConnectionParameters

        public Map<String,​Object> getConnectionParameters()
        Retrieve the connection parameters entered
        Returns:
        the Map of connection parameters

      • getFile

        public File getFile()
        Helper method that returns the "url" element of the connection parameters as a File, if present. Equivalent to: 
        
     URL url = (URL) myWizard.getConnectionParameters().get("url");
     File file = URLs.urlToFile(url);
        Returns:
        url parameter as a File, or null if not applicable