Package org.geotools.swing.styling
Class JSimpleStyleDialog
- All Implemented Interfaces:
ImageObserver,MenuContainer,Serializable,Accessible,RootPaneContainer,WindowConstants
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:
-
Nested Class Summary
Nested classes/interfaces inherited from class JDialog
JDialog.AccessibleJDialogNested classes/interfaces inherited from class Dialog
Dialog.AccessibleAWTDialog, Dialog.ModalExclusionType, Dialog.ModalityTypeNested classes/interfaces inherited from class Window
Window.AccessibleAWTWindow, Window.TypeNested classes/interfaces inherited from class Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Colorstatic final Colorstatic final floatstatic final floatstatic final floatstatic final StringFields inherited from class JDialog
accessibleContext, rootPane, rootPaneCheckingEnabledFields inherited from class Dialog
DEFAULT_MODALITY_TYPEFields inherited from class Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface WindowConstants
DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE -
Constructor Summary
ConstructorsConstructorDescriptionJSimpleStyleDialog(Dialog owner, SimpleFeatureType schema, Style initialStyle) Constructor.JSimpleStyleDialog(Frame owner, SimpleFeatureType schema, Style initialStyle) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionbooleanQuery if the dialog was completed (user clicked the Apply button)Get the selected fill colorGets the geometry type of the selected feature type.Get the feature field (attribute) to use for labelsGet the font to use for labelsGet the selected line colorfloatGet the selected line widthfloatGet the fill opacityfloatGet the selected point sizeGet the selected point symbol namestatic StyleshowDialog(Component parent, DataStore dataStore) Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the first feature type in thedataStore.static StyleshowDialog(Component parent, DataStore dataStore, Style initialStyle) Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the first feature type in thedataStore.static StyleshowDialog(Component parent, SimpleFeatureType featureType) Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the given feature type.static StyleshowDialog(Component parent, SimpleFeatureType featureType, Style initialStyle) Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the given feature type.static StyleshowDialog(Component parent, StyleLayer layer) Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the givenStyleLayer.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, updateMethods inherited from class Dialog
addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBackMethods 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, 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, toFrontMethods 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, validateTreeMethods 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
-
Field Details
-
DEFAULT_LINE_COLOR
-
DEFAULT_FILL_COLOR
-
DEFAULT_LINE_WIDTH
public static final float DEFAULT_LINE_WIDTH- See Also:
-
DEFAULT_OPACITY
public static final float DEFAULT_OPACITY- See Also:
-
DEFAULT_POINT_SIZE
public static final float DEFAULT_POINT_SIZE- See Also:
-
DEFAULT_POINT_SYMBOL_NAME
- See Also:
-
-
Constructor Details
-
JSimpleStyleDialog
Constructor.- Parameters:
owner- the parent Frame (may be null)schema- the feature type for which the style is being createdinitialStyle- an optional Style object to initialize the dialog (may benull)- Throws:
IllegalStateException- if the data store cannot be accessed
-
JSimpleStyleDialog
Constructor.- Parameters:
owner- the parent Dialog (may be null)schema- the feature type for which the style is being createdinitialStyle- an optional Style object to initialize the dialog (may benull)- Throws:
IllegalStateException- if the data store cannot be accessed
-
-
Method Details
-
showDialog
Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the givenStyleLayer. 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
Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the first feature type in thedataStore.- 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
Static convenience method: displays aJSimpleStyleDialogto prompt the user for style preferences to use with the first feature type in thedataStore.- Parameters:
parent- parent JFrame (may be null)dataStore- data store with the features to be renderedinitialStyle- an optional Style object to initialize the dialog (may benull)- Returns:
- a new Style instance or null if the user cancels the dialog
-
showDialog
Static convenience method: displays aJSimpleStyleDialogto 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
Static convenience method: displays aJSimpleStyleDialogto 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 displayinitialStyle- an optional Style object to initialize the dialog (may benull)- 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
Gets the geometry type of the selected feature type. Returnsnullif the user cancelled the dialog.- Returns:
- the geometry type
-
getLineColor
Get the selected line color- Returns:
- line color
-
getFillColor
Get the selected fill color- Returns:
- fill color
-
getOpacity
public float getOpacity()Get the fill opacity- Overrides:
getOpacityin classWindow- 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
Get the selected point symbol name- Returns:
- symbol name
-
getLabelField
Get the feature field (attribute) to use for labels- Returns:
- field name
-
getLabelFont
Get the font to use for labels- Returns:
- a GeoTools Font object
-