oracle.javatools.ui.ghost
Class GhostPointingPalette

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JLayeredPane
                  oracle.javatools.ui.ghost.GhostPalette
                      oracle.javatools.ui.ghost.GhostPointingPalette

All Implemented Interfaces:

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

public class GhostPointingPalette
extends GhostPalette

Derivative of GhostPalette that underlays a pointing arrow to an area of a given component.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.javatools.ui.ghost.GhostPalette

GhostPalette.ContentPanel

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

javax.swing.JLayeredPane.AccessibleJLayeredPane

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class oracle.javatools.ui.ghost.GhostPalette

container, fadeAmount, look

Fields inherited from class javax.swing.JLayeredPane

DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER

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

GhostPointingPalette()

Method Summary

protected void	dispose() Remove the panel from the layer and clean up the panel, it can not be shown again.
void	hidePanel()
void	repaint()
void	repaint(java.awt.Rectangle r)
void	repaintVisible() Will repaint only the visible (i.e.
void	setCloseVisible(boolean visible) Override to update the border when close button is present in GhostPointingPalette
void	setPointing(javax.swing.JComponent pointComp, java.awt.Point locationInComponent) Add a pointing arrow from this ghost panel to a point is a specific component.
void	setPointing(javax.swing.JComponent pointComp, java.awt.Rectangle RectangleInComponent) Add a pointing arrow from this ghost panel to a point within the bounds of a rectangle in a specific component.
void	setShowRectangle(boolean showRect) Determines whether to paint a rectangle around the given source component rectangle
void	setTitle(java.lang.String title) Override to update the border when title is present for GhostPointingPalette
void	show(javax.swing.JLayeredPane layeredPane, boolean positionInLayer, boolean fadeIn) Display this ghost panel in the given JLayeredPane.

Methods inherited from class oracle.javatools.ui.ghost.GhostPalette

add, addImpl, allowTemporaryHide, fadeInOut, getContentPanel, getLook, getOwningComponent, getReceivesFocus, getTitle, isCloseVisible, isHideOnLoseFocus, isMovable, isResizable, makeVisible, pack, paint, positionPanel, registerTransparentComponent, remove, removeNotify, setBounds, setHideOnControlUp, setHideOnLoseFocus, setLayout, setLook, setMovable, setOwningComponent, setReceivesFocus, setResizable, unregisterTransparentComponent

Methods inherited from class javax.swing.JLayeredPane

getAccessibleContext, getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paramString, putLayer, remove, removeAll, setLayer, setLayer, setPosition

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, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, 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, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, 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, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, 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

GhostPointingPalette

public GhostPointingPalette()

Method Detail

setPointing

public void setPointing(javax.swing.JComponent pointComp,
                        java.awt.Point locationInComponent)

Add a pointing arrow from this ghost panel to a point is a specific component. If the component is moved then the point will update to point to the adjusted location.

Parameters:

pointComp -

locationInComponent -

setPointing

public void setPointing(javax.swing.JComponent pointComp,
                        java.awt.Rectangle RectangleInComponent)

Add a pointing arrow from this ghost panel to a point within the bounds of a rectangle in a specific component. The point pointed to within the rectangle is determined by the placement of the ghost panel at run time. If the component is moved then the point will update to point to the adjusted location.

Parameters:

pointComp -

RectangleInComponent -

repaint

public void repaint()

Overrides:

repaint in class java.awt.Component

repaint

public void repaint(java.awt.Rectangle r)

Overrides:

repaint in class javax.swing.JComponent

setShowRectangle

public void setShowRectangle(boolean showRect)

Determines whether to paint a rectangle around the given source component rectangle

Parameters:

showRect -

hidePanel

public void hidePanel()

Overrides:

hidePanel in class GhostPalette

dispose

protected void dispose()

Remove the panel from the layer and clean up the panel, it can not be shown again.

Overrides:

dispose in class GhostPalette

show

public void show(javax.swing.JLayeredPane layeredPane,
                 boolean positionInLayer,
                 boolean fadeIn)

Display this ghost panel in the given JLayeredPane. This call triggers the fade in effect and the panel is visible and ready to recieve input as soon as this method returns. Panel size should be set before this call, either explicitly or via a call to pack(); Similarly location can either be determined beforehand or automatically set with the positionInLayer parameter.

Overrides:

show in class GhostPalette

Parameters:

layeredPane - in which to add the ghost panel. This is usually a JFrame.getLayeredPane()

positionInLayer - true if this component is automatically positioned in the provided layeredPane.

fadeIn - true if the component will fade in, false will show it immediately

repaintVisible

public void repaintVisible()

Will repaint only the visible (i.e. non-completely-transparent) area. This is the panel background and the point

Overrides:

repaintVisible in class GhostPalette

setTitle

public void setTitle(java.lang.String title)

Override to update the border when title is present for GhostPointingPalette

Overrides:

setTitle in class GhostPalette

Parameters:

title - the title text, or use null to signify no title

setCloseVisible

public void setCloseVisible(boolean visible)

Override to update the border when close button is present in GhostPointingPalette

Overrides:

setCloseVisible in class GhostPalette