de.hunsicker.jalopy.swing
Class AbstractSettingsPage

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--de.hunsicker.jalopy.swing.AbstractSettingsPage

All Implemented Interfaces:

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

Direct Known Subclasses:

BlankLinesSettingsPage, BracesSettingsPage, CodeInspectorSettingsPage, CommentsSettingsPage, EnumSettingsPage, EnvironmentSettingsPage, GeneralSettingsPage, HeaderSettingsPage, ImportsSettingsPage, IndentationSettingsPage, JavadocSettingsPage, MessagesSettingsPage, MiscSettingsPage, NamingSettingsPage, ProjectSettingsPage, SortingSettingsPage, WhitespaceSettingsPage, WrappingSettingsPage

public abstract class AbstractSettingsPage

extends javax.swing.JPanel

Skeleton implementation of a settings page. A settings page provides the graphical means to display/edit a given subset of the Jalopy code convention settings.

Version:

$Revision: 1.3.2.3 $

Author:

Marco Hunsicker

See Also:

Serialized Form

Field Summary

protected java.util.ResourceBundle	bundle ResourceBundle that provides the localized string resources for the graphical components.
protected static java.lang.String	DELIMETER The Deliminator
protected Convention	settings The code convention to display/edit.

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

AbstractSettingsPage()
Creates a new AbstractSettingsPage.

Method Summary

protected java.lang.String[]	createItemList(int[] values) Creates a list with the string values of the given integer values.
java.lang.String	getCategory() Returns the category.
Convention	getConvention() Returns the current code convention.
protected java.lang.String	getPreviewFileName() Returns the file name of the preview file to use for this page.
java.lang.String	getTitle() Returns the title of this page.
void	setCategory(java.lang.String category) Sets the name of this page's category.
void	setConvention(Convention convention) Sets the current code convention.
void	setTitle(java.lang.String title) Sets the title of this page.
abstract void	updateSettings() Updates the current code convention to reflect the current state of this page.
void	validateSettings() Validates this page's settings.

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

DELIMETER

protected static final java.lang.String DELIMETER

The Deliminator

See Also:

Constant Field Values

bundle

protected final java.util.ResourceBundle bundle

ResourceBundle that provides the localized string resources for the graphical components.

settings

protected Convention settings

The code convention to display/edit.

Constructor Detail

AbstractSettingsPage

public AbstractSettingsPage()

Creates a new AbstractSettingsPage.

Method Detail

setCategory

public void setCategory(java.lang.String category)

Sets the name of this page's category.

Parameters:

category - name of the category.

getCategory

public java.lang.String getCategory()

Returns the category.

Returns:

the category.

setConvention

public void setConvention(Convention convention)

Sets the current code convention.

Parameters:

convention - code convention.

getConvention

public Convention getConvention()

Returns the current code convention.

Returns:

the current code convention.

setTitle

public void setTitle(java.lang.String title)

Sets the title of this page.

Parameters:

title - the title.

getTitle

public java.lang.String getTitle()

Returns the title of this page.

Returns:

the title of this page.

updateSettings

public abstract void updateSettings()

Updates the current code convention to reflect the current state of this page.

See Also:

getConvention()

validateSettings

public void validateSettings()
                      throws ValidationException

Validates this page's settings. Pages that need their input validated should override to provide the needed implementation.

In case of any violation the implementation should simply display an error message and throw a ValidationException to inform the caller about the invalid input.

Throws:

ValidationException - if the current settings are not valid.

Since:

1.0b8

createItemList

protected java.lang.String[] createItemList(int[] values)

Creates a list with the string values of the given integer values.

Parameters:

values - array with a set of integers.

Returns:

string values of the given array.

Since:

1.0b9

getPreviewFileName

protected java.lang.String getPreviewFileName()

Returns the file name of the preview file to use for this page. Normally the file name is equivalent to the category name, but pages that use tabbed panes may want to override this method to provide different files for their different panes.

Returns:

the file name (no path, without extension) of the preview file to use. Returns null if the page does not have a preview file associated.

Since:

1.0b8