net.sf.genuine.organizer
Class AbstractComponent

java.lang.Object
  extended byjava.awt.Component
      extended byjava.awt.Container
          extended byjavax.swing.JComponent
              extended bynet.sf.genuine.organizer.AbstractComponent
All Implemented Interfaces:
ComponentListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, VisualComponent
Direct Known Subclasses:
PreferencesComponent

public abstract class AbstractComponent
extends javax.swing.JComponent
implements VisualComponent, ComponentListener

This class may be used as super class for all visual components. It sub classes JComponent and contains helper methods to conveniently access the framework's functionality for components.

Author:
Tim Wellhausen
See Also:
VisualComponent, Serialized Form

Nested Class Summary
 
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
 
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.Container
 
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
AbstractComponent(java.lang.String moduleId, java.lang.String componentId, java.lang.String instanceId, ModuleManager moduleManager)
          Panel is initialized with its id and a reference to the module this panel belongs to.
 
Method Summary
 void addComponentListener(ComponentListener listener)
          Adds a component listener for this component by calling the component manager.
 void changeComponentTitle(java.lang.String title)
          Changes the title of this component by calling the component manager.
 void componentActivated(java.lang.String moduleId, java.lang.String componentId, java.lang.String instanceId)
          Default call-back implementation that is called when this component is activated.
 void componentDeactivated(java.lang.String moduleId, java.lang.String componentId, java.lang.String instanceId)
          Default call-back implementation that is called when this component is deactivated.
 void componentHidden(java.lang.String moduleId, java.lang.String componentId, java.lang.String instanceId)
          Default call-back implementation that is called when this component is hidden.
 void componentShown(java.lang.String moduleId, java.lang.String componentId, java.lang.String instanceId)
          Default call-back implementation that is called when this component is shown.
 java.lang.String getComponentId()
          Returns the component id.
protected  ComponentManager getComponentManager()
          Convenience method for the component manager
protected  HelperService getHelperService()
          Convenience method for the helper service
 java.lang.String getInstanceId()
          Returns the instance id of this component.
protected  MessageBus getMessageBus()
          Convenience method for the message bus
 java.lang.String getModuleId()
          Returns the id of the module this component belongs to.
protected  ModuleManager getModuleManager()
          Convenience method for the module manager
protected  ServiceBroker getServiceBroker()
          Returns the reference to the service broker.
protected  void hideComponent()
          Hides this component by calling the component manager
 void removeComponentListener(java.lang.String moduleId, java.lang.String componentId, java.lang.String instanceId, ComponentListener listener)
          Removes a component listener for this component by calling the component manager.
 void setDefaultButton(GenuineButton defaultButton)
          Sets the given button as default button
protected  void showComponent()
          Shows this component by calling the component manager
 
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, getAccessibleContext, 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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI
 
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
 

Constructor Detail

AbstractComponent

public AbstractComponent(java.lang.String moduleId,
                         java.lang.String componentId,
                         java.lang.String instanceId,
                         ModuleManager moduleManager)
Panel is initialized with its id and a reference to the module this panel belongs to.

Method Detail

getComponentId

public java.lang.String getComponentId()
Returns the component id.

Specified by:
getComponentId in interface VisualComponent

getModuleId

public java.lang.String getModuleId()
Returns the id of the module this component belongs to.

Specified by:
getModuleId in interface VisualComponent

getInstanceId

public java.lang.String getInstanceId()
Returns the instance id of this component.

Specified by:
getInstanceId in interface VisualComponent

getModuleManager

protected ModuleManager getModuleManager()
Convenience method for the module manager


getServiceBroker

protected ServiceBroker getServiceBroker()
Returns the reference to the service broker.


getComponentManager

protected ComponentManager getComponentManager()
Convenience method for the component manager


getMessageBus

protected MessageBus getMessageBus()
Convenience method for the message bus


getHelperService

protected HelperService getHelperService()
Convenience method for the helper service


showComponent

protected void showComponent()
Shows this component by calling the component manager


hideComponent

protected void hideComponent()
Hides this component by calling the component manager


setDefaultButton

public void setDefaultButton(GenuineButton defaultButton)
Sets the given button as default button


changeComponentTitle

public void changeComponentTitle(java.lang.String title)
Changes the title of this component by calling the component manager.


addComponentListener

public void addComponentListener(ComponentListener listener)
Adds a component listener for this component by calling the component manager.


removeComponentListener

public void removeComponentListener(java.lang.String moduleId,
                                    java.lang.String componentId,
                                    java.lang.String instanceId,
                                    ComponentListener listener)
Removes a component listener for this component by calling the component manager.


componentActivated

public void componentActivated(java.lang.String moduleId,
                               java.lang.String componentId,
                               java.lang.String instanceId)
Default call-back implementation that is called when this component is activated.

Specified by:
componentActivated in interface ComponentListener

componentDeactivated

public void componentDeactivated(java.lang.String moduleId,
                                 java.lang.String componentId,
                                 java.lang.String instanceId)
Default call-back implementation that is called when this component is deactivated.

Specified by:
componentDeactivated in interface ComponentListener

componentShown

public void componentShown(java.lang.String moduleId,
                           java.lang.String componentId,
                           java.lang.String instanceId)
Default call-back implementation that is called when this component is shown.

Specified by:
componentShown in interface ComponentListener

componentHidden

public void componentHidden(java.lang.String moduleId,
                            java.lang.String componentId,
                            java.lang.String instanceId)
Default call-back implementation that is called when this component is hidden.

Specified by:
componentHidden in interface ComponentListener