com.dlsc.flexgantt.swing.layer.system

## Class DefaultPopupRenderer

- java.lang.Object
- - java.awt.Component
  - - java.awt.Container
    - - javax.swing.JComponent
      - - javax.swing.JPanel
        - - com.dlsc.flexgantt.swing.layer.system.AbstractPopupRenderer
          - - com.dlsc.flexgantt.swing.layer.system.DefaultPopupRenderer

- All Implemented Interfaces:
    IPopupRenderer, IRenderer, ImageObserver, MenuContainer, Serializable, Accessible, Border

      public class DefaultPopupRenderer
      extends AbstractPopupRenderer

  A popup renderer implementation that uses a `JTextArea` to display the string returned from invoking `Object.toString()` on the popup value object.
  Since:
    1.0
  Version:
    $Revision: 1.9 $
  Author:
    Dirk Lemmermann
  See Also:
    `PopupLayer.setPopupRenderer(Class, IPopupRenderer)`, `PopupLayer.getPopupRenderer(Class)`, 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 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 and Description
    `DefaultPopupRenderer()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected JComponent` | `createContentArea()` Creates the content of the popup.
    `Component` | `getPopupRendererComponent(PopupLayer pl, Object titleValue, Object popupValue, IRelationship relationship, IGanttChartModel model)` Returns the component that will be used as a popup that provides additional information about a relationship.
    `JComponent` | `getPopupRendererComponent(PopupLayer pl, Object titleValue, Object popupValue, TimelineObjectPath path, IGanttChartModel model, boolean pinned)` Returns the component that will be used as a popup that provides additional information about a timeline object.
    `Component` | `getPopupRendererComponent(PopupLayer pl, Object titleValue, Object popupValue, TreePath path, IGanttChartModel model, boolean pinned)` Returns the component that will be used as a popup that provides additional information about a tree table node.
    `protected String` | `getPopupText(Object popupValue)` Converts the given popup value to a String.
    `JTextArea` | `getTextArea()` Returns the text area that is used inside the renderer to display the popup text.

    - ### Methods inherited from class com.dlsc.flexgantt.swing.layer.system.AbstractPopupRenderer

      `firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackgroundColor1, getBackgroundColor2, getBorderInsets, getLineColor, getPopupTitleText, getTextColor, getTitleIcon, getTitleIcon, getTitleIcon, getTitleLabel, isBorderOpaque, isRenderingArrow, isVisible, paintBorder, repaint, repaint, repaint, setBackgroundColor1, setBackgroundColor2, setLineColor, setRenderingArrow, setTextColor, validate`

    - ### 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, 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, 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, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, 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, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### DefaultPopupRenderer

          public DefaultPopupRenderer()

  - ### Method Detail

    - #### createContentArea

          protected JComponent createContentArea()

      Description copied from class: `AbstractPopupRenderer`
      Creates the content of the popup. The default implementation `DefaultPopupRenderer` creates a text area as its content. Subclasses can override to create their own content.
      Specified by:
        `createContentArea` in class `AbstractPopupRenderer`
      Returns:
        a component used for the content area of the popup renderer

    - #### getPopupRendererComponent

          public JComponent getPopupRendererComponent(PopupLayer pl,
                                                      Object titleValue,
                                                      Object popupValue,
                                                      TimelineObjectPath path,
                                                      IGanttChartModel model,
                                                      boolean pinned)

      Description copied from interface: `IPopupRenderer`
      Returns the component that will be used as a popup that provides additional information about a timeline object.
      Specified by:
        `getPopupRendererComponent` in interface `IPopupRenderer`
      Overrides:
        `getPopupRendererComponent` in class `AbstractPopupRenderer`
      Parameters:
        `pl` - the popup layer that requires a popup
        `titleValue` - the object that represents the input for the title of the popup
        `popupValue` - the object that represents the input for the popup
        `path` - the path to the timeline object
        `model` - the data source
        `pinned` - indicates whether the popup is visible because it is sticky (TRUE) or because the mouse cursor hovers over the timeline object (FALSE)
      Returns:
        a component to be used as a popup
      See Also:
        `IPopupPolicy.getPopupValue(TimelineObjectPath, IGanttChartModel, boolean)`

    - #### getPopupRendererComponent

          public Component getPopupRendererComponent(PopupLayer pl,
                                                     Object titleValue,
                                                     Object popupValue,
                                                     TreePath path,
                                                     IGanttChartModel model,
                                                     boolean pinned)

      Description copied from interface: `IPopupRenderer`
      Returns the component that will be used as a popup that provides additional information about a tree table node.
      Specified by:
        `getPopupRendererComponent` in interface `IPopupRenderer`
      Overrides:
        `getPopupRendererComponent` in class `AbstractPopupRenderer`
      Parameters:
        `pl` - the popup layer that requires a popup
        `titleValue` - the object that represents the input for the title of the popup
        `popupValue` - the object that represents the input for the popup
        `path` - the path to the tree node
        `model` - the data source
        `pinned` - indicates whether the popup is visible because it is sticky (TRUE) or because the mouse cursor hovers over the timeline object (FALSE)
      Returns:
        a component to be used as a popup
      See Also:
        `IPopupPolicy.getPopupValue(TreePath, IGanttChartModel, boolean)`

    - #### getPopupRendererComponent

          public Component getPopupRendererComponent(PopupLayer pl,
                                                     Object titleValue,
                                                     Object popupValue,
                                                     IRelationship relationship,
                                                     IGanttChartModel model)

      Description copied from interface: `IPopupRenderer`
      Returns the component that will be used as a popup that provides additional information about a relationship.
      Specified by:
        `getPopupRendererComponent` in interface `IPopupRenderer`
      Overrides:
        `getPopupRendererComponent` in class `AbstractPopupRenderer`
      Parameters:
        `pl` - the popup layer that requires a popup
        `titleValue` - the object that represents the input for the title of the popup
        `popupValue` - the object that represents the input for the popup
        `relationship` - the relationship for which a popup will be shown
        `model` - the data source
      Returns:
        a component to be used as a popup
      See Also:
        `IPopupPolicy.getPopupValue(TreePath, IGanttChartModel, boolean)`

    - #### getPopupText

          protected String getPopupText(Object popupValue)

      Converts the given popup value to a String. The value was previously returned from the popup policy. The default implementation of this method will simply call `Object.toString()` on the popup value. Subclasses may override to return a text that is computed based on the value object.
      Overrides:
        `getPopupText` in class `AbstractPopupRenderer`
      Parameters:
        `popupValue` - the value returned from the popup policy
      Returns:
        a text based on the given popup value
      Since:
        1.0
      See Also:
        `IPopupPolicy.getPopupValue(TimelineObjectPath, IGanttChartModel, boolean)`, `IPopupPolicy.getPopupValue(TreePath, IGanttChartModel, boolean)`

    - #### getTextArea

          public JTextArea getTextArea()

      Returns the text area that is used inside the renderer to display the popup text.
      Returns:
        a text area that is used to show the popup text
      Since:
        1.0

Copyright © 2006–2020 Dirk Lemmermann Software & Consulting. All rights reserved.