com.tensegrity.gui.swing.dialog.panel
Class FormatMarker

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.tensegrity.gui.swing.dialog.panel.Panel
                      com.tensegrity.gui.swing.dialog.panel.AbstractFormat
                          com.tensegrity.gui.swing.dialog.panel.FormatMarker

All Implemented Interfaces:

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

public class FormatMarker

extends AbstractFormat

The FormatMarker is the configuration panel for a MarkerFormat. It uses FormatStroke and FormatPaint to allow users to specify the border and the fill for an Arrow.

Version:

$Id: FormatMarker.java,v 1.28 2006/03/02 11:40:57 BurkhardWick Exp $

Author:

GillesIachelini

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

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

Field Summary

protected int	size Size of the marker.
protected int	type The type of the marker.

Fields inherited from class com.tensegrity.gui.swing.dialog.panel.Panel

changed, uiItemEvList, uiManager

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

FormatMarker(UIManager uiManager, AbstractPreview preview)
Constructor for FormatMarker.

FormatMarker(UIManager uiManager, AbstractPreview preview, javax.swing.JPanel previewPanel)
This constructor allows you to pass a Panel to be used as preview panel for this formatter.

Method Summary

boolean	containsPreview() Returns true, if this format panel contains its own preview
Format	getFormat() Each Format implementation must return an instance of Format.
java.lang.String	getFormatName() Overwritten.
MarkerFormat	getMarkerFormat() Returns the Marker based on the values of the internal fields.
AbstractPreview	getPreview() Returns an AbstractPreview instance used by this panel or null, if no such Preview is in use.
void	setMarkerFormat(MarkerFormat marker) Sets the values of the given marker to the internal fields and updates the preview.
protected void	updatePreview() Updates the internal preview instance of this format panel by setting the MarkerFormat based on the internal values.
boolean	validateFormat() The validate method gets called whenever a validation of the currently entered value should be done.

Methods inherited from class com.tensegrity.gui.swing.dialog.panel.AbstractFormat

setFormatName

Methods inherited from class com.tensegrity.gui.swing.dialog.panel.Panel

applyEvList, fillBack, installEvList

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

type

protected int type

The type of the marker.

size

protected int size

Size of the marker.

Constructor Detail

FormatMarker

public FormatMarker(UIManager uiManager,
                    AbstractPreview preview)

Constructor for FormatMarker.

Parameters:

uiManager - UIManager required for all Strings.

preview - optional instance of a Preview for this panel.

FormatMarker

public FormatMarker(UIManager uiManager,
                    AbstractPreview preview,
                    javax.swing.JPanel previewPanel)

This constructor allows you to pass a Panel to be used as preview panel for this formatter. This is useful, if no general preview should be used, rather a separate one.

Parameters:

uiManager - The UIManager

preview - The AbstractPreview, we still need it also if a separate Preview panel is used.

previewPanel - The Panel containing a Preview.

Method Detail

getFormat

public Format getFormat()

Description copied from class: AbstractFormat

Each Format implementation must return an instance of Format. This lets users of the panels allow to retrieve the currently configured Format instance.

Specified by:

getFormat in class AbstractFormat

Returns:

the instance of a Format.

getMarkerFormat

public MarkerFormat getMarkerFormat()

Returns the Marker based on the values of the internal fields.

Returns:

Creates a MarkerFormat from the internal fields.

setMarkerFormat

public void setMarkerFormat(MarkerFormat marker)

Sets the values of the given marker to the internal fields and updates the preview.

Parameters:

marker - the MarkerFormat to set on this panel.

updatePreview

protected void updatePreview()

Updates the internal preview instance of this format panel by setting the MarkerFormat based on the internal values.

See Also:

AbstractPreview#setMarkerFormat(int, int, int, int, int, int, int, int, boolean, int, int, int)

getPreview

public AbstractPreview getPreview()

Description copied from class: AbstractFormat

Returns an AbstractPreview instance used by this panel or null, if no such Preview is in use.

Specified by:

getPreview in class AbstractFormat

Returns:

a Preview implementation or null.

getFormatName

public java.lang.String getFormatName()

Description copied from class: AbstractFormat

Overwritten. Meant to return a human readable name for this panel to describe its Format.

Overrides:

getFormatName in class AbstractFormat

Returns:

the name of the format.

validateFormat

public boolean validateFormat()

Description copied from class: AbstractFormat

The validate method gets called whenever a validation of the currently entered value should be done.

Specified by:

validateFormat in class AbstractFormat

Returns:

true, if the validation succeeded, false otherwise.

containsPreview

public boolean containsPreview()

Description copied from class: AbstractFormat

Returns true, if this format panel contains its own preview

Overrides:

containsPreview in class AbstractFormat

Returns:

true, if this format panel contains its own preview