Package org.gvsig.andami.preferences

Class AbstractPreferencePage

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gvsig.gui.beans.swing.GridBagLayoutPanel

org.gvsig.andami.preferences.AbstractPreferencePage

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, IPreference, org.gvsig.tools.extensionpoint.ExtensionBuilder

public abstract class AbstractPreferencePage
extends org.gvsig.gui.beans.swing.GridBagLayoutPanel
implements IPreference, org.gvsig.tools.extensionpoint.ExtensionBuilder

The abstract class that any preference page should extend.

Author:

jaume dominguez faus - jaume.dominguez@iver.es

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

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

Field Summary

Fields

Modifier and Type	Field	Description
protected String	parentID
protected int	y	The number of components already added to the layout manager.

Fields inherited from class javax.swing.JComponent

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

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

Fields inherited from interface org.gvsig.andami.preferences.IPreference

ACCESS_PREFERENCES_PAGE_AUTHORIZATION

Constructor Summary

Constructors

Constructor	Description
AbstractPreferencePage()

Method Summary

Modifier and Type	Method	Description
Object	create()
Object	create(Object[] args)
Object	create(Map args)
String	getParentID()	Returns the ID of the parent of this layer.
boolean	isResizeable()	Devuelve true si el Panel debe estar en un BorderLayout centrado o false si tiene un tamaño fijo.
final void	saveValues()	Saves the new settings
abstract void	setChangesApplied()	After this method is invoked, the Preference page must return true as the result of invoking isValueChanged() method.
final void	setParentID(String parentID)
final void	setTitle(String title)
abstract void	storeValues()	Gathers the configurations and stores them in the system.
String	toString()

Methods inherited from class org.gvsig.gui.beans.swing.GridBagLayoutPanel

addBlank, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, addComponent, hasChanged, newLabel, setChanged

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.andami.preferences.IPreference

getIcon, getID, getPanel, getTitle, initializeDefaults, initializeValues, isValueChanged

Field Details

y

protected int y

The number of components already added to the layout manager.

parentID

protected String parentID

Constructor Details

AbstractPreferencePage

public AbstractPreferencePage()

Method Details

setParentID

public final void setParentID(String parentID)

getParentID

public String getParentID()

Description copied from interface: IPreference

Returns the ID of the parent of this layer. If this method returns null, which means that this preferences page has no parent, this is new entry in the preferences tree, otherwise this preferences page will be hanging on the page with the ID returned by this.

Specified by:

getParentID in interface IPreference

Returns:

setTitle

public final void setTitle(String title)

toString

public String toString()

Overrides:

toString in class Component

create

public Object create()

Specified by:

create in interface org.gvsig.tools.extensionpoint.ExtensionBuilder

create

public Object create(Object[] args)

Specified by:

create in interface org.gvsig.tools.extensionpoint.ExtensionBuilder

create

public Object create(Map args)

Specified by:

create in interface org.gvsig.tools.extensionpoint.ExtensionBuilder

isResizeable

public boolean isResizeable()

Devuelve true si el Panel debe estar en un BorderLayout centrado o false si tiene un tamaño fijo.

Returns:

saveValues

public final void saveValues()
                      throws StoreException

Description copied from interface: IPreference

Saves the new settings

Specified by:

saveValues in interface IPreference

Throws:

StoreException

storeValues

public abstract void storeValues()
                          throws StoreException

Gathers the configurations and stores them in the system.

storeValues() and setChangesApplied() are methods from AbstractPreferencePage not from IPreference. They both perform in combination what saveValue() should do by itself, but they exist for performance issues. In fact, you should not invoke them outside your PreferencePage class, you only need to code them.

Throws:

StoreException

setChangesApplied

public abstract void setChangesApplied()

After this method is invoked, the Preference page must return true as the result of invoking isValueChanged() method. It tells that the values have been saved in the system.

storeValues() and setChangesApplied() are methods from AbstractPreferencePage not from IPreference. They both perform in combination what storeValue() should by itself, but they exist for performance issues. In fact, you should not invoke them outside your PreferencePage class, you only need to code them.