org.geotools.swing.styling
Class JSimpleStyleDialog

Object
  extended by Component
      extended by Container
          extended by Window
              extended by Dialog
                  extended by JDialog
                      extended by JSimpleStyleDialog
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

public class JSimpleStyleDialog
extends JDialog

A dialog to prompt the user for feature style choices. It has a number of static showDialog methods to work with different sources (SimpleFeatureType, Layer, DataStore). Each of these displays a dialog and then creates a new Style instance.

Examples of use:


 // Use with a shapefile
 Component parentGUIComponent = null;
 ShapefileDataStore shapefile = ...
 Style style = JSimpleStyleDialog.showDialog(parentGUIComponent, shapefile);
 if (style != null) {
    // create a layer using this style
 }

 // Use with an existing Layer
 Layer layer = ...
 Style style = JSimpleStyleDialog.showDialog(parentGUIComponent, layer);
 if (style != null) {
     layer.setStyle( style );
 }
 

Since:
2.6
Author:
Michael Bedward
See Also:
SLD style helper class, 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
 
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
static Color DEFAULT_FILL_COLOR
           
static Color DEFAULT_LINE_COLOR
           
static float DEFAULT_LINE_WIDTH
           
static float DEFAULT_OPACITY
           
static float DEFAULT_POINT_SIZE
           
static String DEFAULT_POINT_SYMBOL_NAME
           
 
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 WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
 
Fields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
JSimpleStyleDialog(Dialog owner, SimpleFeatureType schema, Style initialStyle)
          Constructor.
JSimpleStyleDialog(Frame owner, SimpleFeatureType schema, Style initialStyle)
          Constructor.
 
Method Summary
 boolean completed()
          Query if the dialog was completed (user clicked the Apply button)
 Color getFillColor()
          Get the selected fill color
 Geometries getGeomType()
          Gets the geometry type of the selected feature type.
 String getLabelField()
          Get the feature field (attribute) to use for labels
 Font getLabelFont()
          Get the font to use for labels
 Color getLineColor()
          Get the selected line color
 float getLineWidth()
          Get the selected line width
 float getOpacity()
          Get the fill opacity
 float getPointSize()
          Get the selected point size
 String getPointSymbolName()
          Get the selected point symbol name
static Style showDialog(Component parent, AbstractDataStore dataStore)
          Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the first feature type in the dataStore.
static Style showDialog(Component parent, AbstractDataStore dataStore, Style initialStyle)
          Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the first feature type in the dataStore.
static Style showDialog(Component parent, SimpleFeatureType featureType)
          Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the given feature type.
static Style showDialog(Component parent, SimpleFeatureType featureType, Style initialStyle)
          Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the given feature type.
static Style showDialog(Component parent, StyleLayer layer)
          Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the given StyleLayer.
 
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, setModal, setModalityType, setResizable, setTitle, setUndecorated, setVisible, show, toBack
 
Methods inherited from class Window
addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, dispose, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, 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, transferFocusBackward, 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, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, isOpaque, 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, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

DEFAULT_LINE_COLOR

public static final Color DEFAULT_LINE_COLOR

DEFAULT_FILL_COLOR

public static final Color DEFAULT_FILL_COLOR

DEFAULT_LINE_WIDTH

public static final float DEFAULT_LINE_WIDTH
See Also:
Constant Field Values

DEFAULT_OPACITY

public static final float DEFAULT_OPACITY
See Also:
Constant Field Values

DEFAULT_POINT_SIZE

public static final float DEFAULT_POINT_SIZE
See Also:
Constant Field Values

DEFAULT_POINT_SYMBOL_NAME

public static final String DEFAULT_POINT_SYMBOL_NAME
See Also:
Constant Field Values
Constructor Detail

JSimpleStyleDialog

public JSimpleStyleDialog(Frame owner,
                          SimpleFeatureType schema,
                          Style initialStyle)
Constructor.

Parameters:
owner - the parent Frame (may be null)
schema - the feature type for which the style is being created
initialStyle - an optional Style object to initialize the dialog (may be null)
Throws:
IllegalStateException - if the data store cannot be accessed

JSimpleStyleDialog

public JSimpleStyleDialog(Dialog owner,
                          SimpleFeatureType schema,
                          Style initialStyle)
Constructor.

Parameters:
owner - the parent Dialog (may be null)
schema - the feature type for which the style is being created
initialStyle - an optional Style object to initialize the dialog (may be null)
Throws:
IllegalStateException - if the data store cannot be accessed
Method Detail

showDialog

public static Style showDialog(Component parent,
                               StyleLayer layer)
Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the given StyleLayer. The layer's existing style, if any, will be used to initialize the dialog.

Parameters:
parent - parent component (may be null)
layer - the map layer
Returns:
a new Style instance or null if the user cancels the dialog

showDialog

public static Style showDialog(Component parent,
                               AbstractDataStore dataStore)
Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the first feature type in the dataStore.

Parameters:
parent - parent JFrame (may be null)
dataStore - data store with the features to be rendered
Returns:
a new Style instance or null if the user cancels the dialog

showDialog

public static Style showDialog(Component parent,
                               AbstractDataStore dataStore,
                               Style initialStyle)
Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the first feature type in the dataStore.

Parameters:
parent - parent JFrame (may be null)
dataStore - data store with the features to be rendered
initialStyle - an optional Style object to initialize the dialog (may be null)
Returns:
a new Style instance or null if the user cancels the dialog

showDialog

public static Style showDialog(Component parent,
                               SimpleFeatureType featureType)
Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the given feature type.

Parameters:
parent - parent component (may be null)
featureType - the feature type that the Style will be used to display
Returns:
a new Style instance or null if the user cancels the dialog

showDialog

public static Style showDialog(Component parent,
                               SimpleFeatureType featureType,
                               Style initialStyle)
Static convenience method: displays a JSimpleStyleDialog to prompt the user for style preferences to use with the given feature type.

Parameters:
parent - parent component (may be null)
featureType - the feature type that the Style will be used to display
initialStyle - an optional Style object to initialize the dialog (may be null)
Returns:
a new Style instance or null if the user cancels the dialog

completed

public boolean completed()
Query if the dialog was completed (user clicked the Apply button)

Returns:
true if completed; false otherwise

getGeomType

public Geometries getGeomType()
Gets the geometry type of the selected feature type. Returns null if the user cancelled the dialog.

Returns:
the geometry type

getLineColor

public Color getLineColor()
Get the selected line color

Returns:
line color

getFillColor

public Color getFillColor()
Get the selected fill color

Returns:
fill color

getOpacity

public float getOpacity()
Get the fill opacity

Returns:
fill opacity between 0 and 1

getLineWidth

public float getLineWidth()
Get the selected line width

Returns:
line width

getPointSize

public float getPointSize()
Get the selected point size

Returns:
point size

getPointSymbolName

public String getPointSymbolName()
Get the selected point symbol name

Returns:
symbol name

getLabelField

public String getLabelField()
Get the feature field (attribute) to use for labels

Returns:
field name

getLabelFont

public Font getLabelFont()
Get the font to use for labels

Returns:
a GeoTools Font object


Copyright © 1996-2014 Geotools. All Rights Reserved.