Package org.gvsig.gui.beans.panelGroup.panels

Class AbstractPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.gvsig.gui.beans.panelGroup.panels.AbstractPanel

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Comparable<IPanel>, Accessible, IPanel

Direct Known Subclasses:

AbstractFilterQueryJPanel, TreePanel.DefaultPanel

public abstract class AbstractPanel
extends JPanel
implements IPanel

Represents a JPanel adapted to work as a panel of an AbstractPanelGroup.

Version:

16/10/2007

Author:

Pablo Piqueras Bartolomé (pablo.piqueras@iver.es)

See Also:

• JPanel
• IPanel
• AbstractPanelGroup
• 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 boolean	hasChanged	Determines if this component has changed since it was created, or applied (or accepted).
protected boolean	remainsWithDefaultPreferredSize	If this panel remains with its initial preferred size of it has been changed.

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

Constructor Summary

Constructors

Constructor	Description
AbstractPanel()	Initializes this panel.
AbstractPanel(String id, String label, String labelGroup)	Initializes this panel using three parameters.

Method Summary

Modifier and Type	Method	Description
int	compareTo(IPanel comparedPanel)
String	getID()	Gets the panel identifier.
String	getLabel()	Gets the identifier of the panel used by a AbstractPanelGroup.
String	getLabelGroup()	Gets the identifier of the panel used to group together different IPanel panels in a AbstractPanelGroup.
AbstractPanelGroup	getPanelGroup()	Gets a reference to the object that contains the group which this panel is a member.
int	getPriority()	The priority of this properties page.
Object	getReference()	Gets the object that has a ''semantically'' or ''conceptually'' relation to this panel, this is used to group IPanel panels on a IPanelGroup object.
boolean	hasChanged()	Determines if this panel has changed since it was created, or applied (or accepted or cancelled).
protected abstract void	initialize()	This method is used by each concrete implementation of AbstractPanel to execute its particular initialization tasks.
boolean	isAlwaysApplicable()	Gets if this panel will always be applied and accepted (by default), or only when has changed.
boolean	isInGroupGUI()	Returns true if this panel belongs to a 'panel group' and it's loaded in the graphical user interface of that component; otherwise returns false.
boolean	remainsWithItsDefaultPreferredSize()	Returns if this panel remains with its initial preferred size of it has been changed.
void	resetChangedStatus()	Resets this panel changed status to its initial value.
void	setAlwaysApplicable(boolean b)	Sets if this panel will always be applied and accepted (by default), or only when has changed.
void	setID(String id)	Sets the identifier of the panel used by a AbstractPanelGroup.
void	setInGroupGUI(boolean visible)	If this panel belongs to a 'panel group', changes its visibility at the interface of the panel group.
void	setLabel(String label)	Sets the identifier of the panel used by a AbstractPanelGroup.
void	setLabelGroup(String labelGroup)	Sets the identifier of the panel used to group together different IPanel panels of a AbstractPanelGroup.
void	setPanelGroup(AbstractPanelGroup panelGroup)	Sets a reference to the object that contains the group which this panel is a member.
void	setPreferredSize(Dimension preferredSize)
void	setPriority(int priority)	Sets priority of this properties page.
void	setReference(Object ref)	Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.
String	toString()

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, 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.gui.beans.panelGroup.panels.IPanel

accept, apply, cancel, selected

Field Details

remainsWithDefaultPreferredSize

protected boolean remainsWithDefaultPreferredSize

If this panel remains with its initial preferred size of it has been changed.

See Also:

• remainsWithItsDefaultPreferredSize()

hasChanged

protected boolean hasChanged

Determines if this component has changed since it was created, or applied (or accepted).

Constructor Details

AbstractPanel

public AbstractPanel()

Initializes this panel.

AbstractPanel

public AbstractPanel(String id,
 String label,
 String labelGroup)

Initializes this panel using three parameters.

Parameters:

id - optional attribute that identifies this panel

label - identifier used by a AbstractPanelGroup to identify this panel

labelGroup - identifier used to group together different IPanel panels in a AbstractPanelGroup

Method Details

initialize

protected abstract void initialize()

This method is used by each concrete implementation of AbstractPanel to execute its particular initialization tasks.

getID

public String getID()

Description copied from interface: IPanel

Gets the panel identifier.

.

Specified by:

getID in interface IPanel

Returns:

panel identifier, or null if undefined

See Also:

• IPanel.setID(String)

getLabel

public String getLabel()

Description copied from interface: IPanel

Gets the identifier of the panel used by a AbstractPanelGroup.

Specified by:

getLabel in interface IPanel

Returns:

panel label identifier, or null if undefined

See Also:

• IPanel.setLabel(String)

getLabelGroup

public String getLabelGroup()

Description copied from interface: IPanel

Gets the identifier of the panel used to group together different IPanel panels in a AbstractPanelGroup.

Specified by:

getLabelGroup in interface IPanel

Returns:

panel label group identifier, or null if undefined

See Also:

• IPanel.setLabelGroup(String)

setID

public void setID(String id)

Description copied from interface: IPanel

Sets the identifier of the panel used by a AbstractPanelGroup.

Specified by:

setID in interface IPanel

Parameters:

id - panel label identifier, or null if undefined

See Also:

• IPanel.getID()

setLabel

public void setLabel(String label)

Description copied from interface: IPanel

Sets the identifier of the panel used by a AbstractPanelGroup.

Specified by:

setLabel in interface IPanel

Parameters:

label - panel label identifier, or null if undefined

See Also:

• IPanel.getLabel()

setLabelGroup

public void setLabelGroup(String labelGroup)

Description copied from interface: IPanel

Sets the identifier of the panel used to group together different IPanel panels of a AbstractPanelGroup.

Specified by:

setLabelGroup in interface IPanel

Parameters:

labelGroup - label group identifier, or null if undefined

See Also:

• IPanel.getLabelGroup()

getReference

public Object getReference()

Description copied from interface: IPanel

Gets the object that has a ''semantically'' or ''conceptually'' relation to this panel, this is used to group IPanel panels on a IPanelGroup object.

Specified by:

getReference in interface IPanel

Returns:

object that has reference this panel, or null if there has reference to no object

See Also:

• IPanel.setReference(Object)

setReference

public void setReference(Object ref)

Description copied from interface: IPanel

Sets a reference to an object that is ''semantically' or 'contextually' related to this panel.

Specified by:

setReference in interface IPanel

Parameters:

ref - an object

See Also:

• IPanel.getReference()

getPanelGroup

public AbstractPanelGroup getPanelGroup()

Description copied from interface: IPanel

Gets a reference to the object that contains the group which this panel is a member.

Specified by:

getPanelGroup in interface IPanel

Returns:

an object that contains this panel's group

See Also:

• IPanel.setPanelGroup(AbstractPanelGroup)

setPanelGroup

public void setPanelGroup(AbstractPanelGroup panelGroup)

Description copied from interface: IPanel

Sets a reference to the object that contains the group which this panel is a member.

Specified by:

setPanelGroup in interface IPanel

Parameters:

panelGroup - object that contains this panel's group

See Also:

• IPanel.getPanelGroup()

setInGroupGUI

public void setInGroupGUI(boolean visible)

Description copied from interface: IPanel

If this panel belongs to a 'panel group', changes its visibility at the interface of the panel group. If changes to invisible, then this panel won't be accessible by the user interface. But if changes to visible and was invisible before, then will appear at the same position it was in the user interface. The position is according the order of the insertion at the group. Anyway, the group will have this panel.

Specified by:

setInGroupGUI in interface IPanel

Parameters:

visible - the new visibility for that panel.

isInGroupGUI

public boolean isInGroupGUI()

Description copied from interface: IPanel

Returns true if this panel belongs to a 'panel group' and it's loaded in the graphical user interface of that component; otherwise returns false.

Specified by:

isInGroupGUI in interface IPanel

Returns:

true if this panel belongs to a 'panel group' and it's loaded in the graphical user interface of that component

toString

public String toString()

Overrides:

toString in class Component

remainsWithItsDefaultPreferredSize

public boolean remainsWithItsDefaultPreferredSize()

Description copied from interface: IPanel

Returns if this panel remains with its initial preferred size of it has been changed.

Specified by:

remainsWithItsDefaultPreferredSize in interface IPanel

Returns:

if this panel remains with its initial preferred size of it has been changed

setPreferredSize

public void setPreferredSize(Dimension preferredSize)

Overrides:

setPreferredSize in class JComponent

hasChanged

public boolean hasChanged()

Description copied from interface: IPanel

Determines if this panel has changed since it was created, or applied (or accepted or cancelled). The programmer of each panel will be whom would set to true that a panel has changed.

Specified by:

hasChanged in interface IPanel

Returns:

true if this panel has changed since it was created, or applied (or accepted or cancelled); otherwise false

resetChangedStatus

public void resetChangedStatus()

Description copied from interface: IPanel

Resets this panel changed status to its initial value.

Specified by:

resetChangedStatus in interface IPanel

setAlwaysApplicable

public void setAlwaysApplicable(boolean b)

Description copied from interface: IPanel

Sets if this panel will always be applied and accepted (by default), or only when has changed.

Specified by:

setAlwaysApplicable in interface IPanel

Parameters:

b - if this panel will always be applied and accepted, or only when has changed

See Also:

• IPanel.isAlwaysApplicable()
• IPanel.hasChanged()

isAlwaysApplicable

public boolean isAlwaysApplicable()

Description copied from interface: IPanel

Gets if this panel will always be applied and accepted (by default), or only when has changed.

Specified by:

isAlwaysApplicable in interface IPanel

Returns:

if this panel will always be applied and accepted, or only when has changed

See Also:

• IPanel.setAlwaysApplicable(boolean)
• IPanel.hasChanged()

getPriority

public int getPriority()

Description copied from interface: IPanel

The priority of this properties page. When more high is the priority more to the left are set properties page.

Specified by:

getPriority in interface IPanel

Returns:

the priority of the properties page

setPriority

public void setPriority(int priority)

Description copied from interface: IPanel

Sets priority of this properties page. When more high is the priority more to the left are set properties page.

Specified by:

setPriority in interface IPanel

compareTo

public int compareTo(IPanel comparedPanel)

Specified by:

compareTo in interface Comparable<IPanel>