oracle.jdeveloper.uieditor.uicanvas
Class SelectNib

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.jdeveloper.uieditor.uicanvas.SelectNib

All Implemented Interfaces:

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

public final class SelectNib
extends javax.swing.JPanel

SelectNib encapsulates the facilities for manipulating selection handles of an associated target displayed upon a UICanvas instance. SelectNib are typically used by the UICanvas and/or LayoutAssistant to render visual feedback to the user during such operations selection and resize.

See Also:

UICanvas, LayoutAssistant, Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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

boolean	anchor Flag field for use by client to indicate whether nib is an anchor.
static int	CENTER Value used for SelectNib.type to indicate a center nib.
static int	EAST Value used for SelectNib.type to indicate a right center nib.
static int	NORTH Value used for SelectNib.type to indicate a top center nib.
static int	NORTH_EAST Value used for SelectNib.type to indicate a top right corner nib.
static int	NORTH_WEST Value used for SelectNib.type to indicate a top left corner nib.
java.awt.Point	parentLocation Absolute coordinates of the target parent relative to the UICanvas.
java.awt.Dimension	rectangleDimension Dimension of the target GUI.
java.awt.Point	rectangleLocation Absolute coordinates of the target GUI relative to the UICanvas.
boolean	selectable Flag field for use by client to indicate whether nib is selectable.
static int	SOUTH Value used for SelectNib.type to indicate a bottom center nib.
static int	SOUTH_EAST Value used for SelectNib.type to indicate a bottom right corner nib.
static int	SOUTH_WEST Value used for SelectNib.type to indicate a bottom left corner nib.
CmtModelNode	target CmtModeNode for which this nib serves as a selection handle.
int	type The type of SelectNib; one of NORTH, SOURTH, etc.
static int	UNUSED Value used for SelectNib.type to indicate an unused nib.
int	use Flag field for use by client to indicate whether nib is in use.
static int	WEST Value used for SelectNib.type to indicate a left center nib.

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

SelectNib()
Constructor.

Method Summary

static void	adjustPositionForNib(java.awt.Point location, java.awt.Dimension size, java.awt.Point p, int nibType) Adjust location and size arguments to reflect changes to a Rectangle based upon the proposed new location of this SelectNib.
LayoutAssistant	getLayoutAssistant() Get the LayoutAssistant associated with this SelectNib.
java.awt.Rectangle	getNibBounds() Get a Rectangle describing the proposed target bounds relative to its parent.
java.awt.Dimension	getRectangleDimension() Get the proposed dimension of the target GUI.
java.awt.Point	getRectangleLocation() Get the proposed absolute coordinates of the target GUI relative to the UICanvas.
void	initialize() (Re)initialize the SelectNib.
boolean	isSelectable() Get selectable flag value.
java.lang.String	resizeAction(java.awt.Point location, UICanvas canvas) Get a descriptive message describing the drag of this SelectNib from its current location to that provided as argument.
void	setBackground(java.awt.Color c) Set the background color of this SelectNib.
void	setLayoutAssistant(LayoutAssistant l) Set the LayoutAssistant to be associated with this SelectNib for use during resizeAction.
void	setRectangleDimension(java.awt.Dimension d) Set the proposed dimenaion of the target GUI.
void	setRectangleLocation(java.awt.Point p) Set the proposed absolute coordinates of the target GUI relative to the UICanvas.
void	setSelectable(boolean isSelectable) Set selectable flag.
java.lang.String	toString() Get a text description of this SelectNode.

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

UNUSED

public static final int UNUSED

Value used for SelectNib.type to indicate an unused nib.

See Also:

Constant Field Values

NORTH_WEST

public static final int NORTH_WEST

Value used for SelectNib.type to indicate a top left corner nib.

See Also:

Constant Field Values

NORTH_EAST

public static final int NORTH_EAST

Value used for SelectNib.type to indicate a top right corner nib.

See Also:

Constant Field Values

SOUTH_WEST

public static final int SOUTH_WEST

Value used for SelectNib.type to indicate a bottom left corner nib.

See Also:

Constant Field Values

SOUTH_EAST

public static final int SOUTH_EAST

Value used for SelectNib.type to indicate a bottom right corner nib.

See Also:

Constant Field Values

NORTH

public static final int NORTH

Value used for SelectNib.type to indicate a top center nib.

See Also:

Constant Field Values

WEST

public static final int WEST

Value used for SelectNib.type to indicate a left center nib.

See Also:

Constant Field Values

EAST

public static final int EAST

Value used for SelectNib.type to indicate a right center nib.

See Also:

Constant Field Values

SOUTH

public static final int SOUTH

Value used for SelectNib.type to indicate a bottom center nib.

See Also:

Constant Field Values

CENTER

public static final int CENTER

Value used for SelectNib.type to indicate a center nib.

See Also:

Constant Field Values

type

public int type

The type of SelectNib; one of NORTH, SOURTH, etc.

use

public int use

Flag field for use by client to indicate whether nib is in use.

selectable

public boolean selectable

Flag field for use by client to indicate whether nib is selectable.

anchor

public boolean anchor

Flag field for use by client to indicate whether nib is an anchor.

target

public CmtModelNode target

CmtModeNode for which this nib serves as a selection handle.

rectangleLocation

public java.awt.Point rectangleLocation

Absolute coordinates of the target GUI relative to the UICanvas.

rectangleDimension

public java.awt.Dimension rectangleDimension

Dimension of the target GUI.

parentLocation

public java.awt.Point parentLocation

Absolute coordinates of the target parent relative to the UICanvas.

Constructor Detail

SelectNib

public SelectNib()

Constructor.

Method Detail

initialize

public void initialize()

(Re)initialize the SelectNib.

getNibBounds

public java.awt.Rectangle getNibBounds()

Get a Rectangle describing the proposed target bounds relative to its parent. The Rectangle returned will be based upon the values held for rectangleLocation and rectangleDimension.

Returns:

the proposed bounds of the target relative to its parent.

See Also:

target, rectangleLocation, rectangleDimension

resizeAction

public java.lang.String resizeAction(java.awt.Point location,
                                     UICanvas canvas)

Get a descriptive message describing the drag of this SelectNib from its current location to that provided as argument. May additionally provide other visual feedback to the user as relevant. The implementation is to simply defer to the associated LayoutAssistant.

Parameters:

location - the proposed new absolute location relative to canvas.

canvas - the UICanvas which owns the SelectNib.

Returns:

a descriptive message describing the resize.

setLayoutAssistant

public void setLayoutAssistant(LayoutAssistant l)

Set the LayoutAssistant to be associated with this SelectNib for use during resizeAction.

Parameters:

l - the LayoutAssistant to associate with this SelectNib.

See Also:

resizeAction(java.awt.Point, oracle.jdeveloper.uieditor.uicanvas.UICanvas), getLayoutAssistant()

getLayoutAssistant

public LayoutAssistant getLayoutAssistant()

Get the LayoutAssistant associated with this SelectNib.

Returns:

the LayoutAssistant associated with this SelectNib.

See Also:

setLayoutAssistant(oracle.jdeveloper.uieditor.uicanvas.LayoutAssistant)

setRectangleLocation

public void setRectangleLocation(java.awt.Point p)

Set the proposed absolute coordinates of the target GUI relative to the UICanvas.

Parameters:

p - the proposed absolute coordinates of the target GUI relative to the UICanvas.

See Also:

target, getRectangleLocation()

getRectangleLocation

public java.awt.Point getRectangleLocation()

Get the proposed absolute coordinates of the target GUI relative to the UICanvas.

Returns:

the proposed absolute coordinates of the target GUI relative to the UICanvas.

See Also:

setRectangleLocation(java.awt.Point)

setRectangleDimension

public void setRectangleDimension(java.awt.Dimension d)

Set the proposed dimenaion of the target GUI.

Parameters:

d - the proposed dimension of the target GUI.

See Also:

target, getRectangleDimension()

getRectangleDimension

public java.awt.Dimension getRectangleDimension()

Get the proposed dimension of the target GUI.

Returns:

the proposed dimension of the target GUI.

See Also:

setRectangleDimension(java.awt.Dimension)

setSelectable

public void setSelectable(boolean isSelectable)

Set selectable flag.

Parameters:

isSelectable - true if this SelectNib is selectable.

See Also:

selectable, #getSelectable

isSelectable

public boolean isSelectable()

Get selectable flag value.

Returns:

whether or not this SelectNib is selectable.

See Also:

selectable, setSelectable(boolean)

setBackground

public void setBackground(java.awt.Color c)

Set the background color of this SelectNib. Ignored if SelectNib is flagged as being an anchor.

Overrides:

setBackground in class javax.swing.JComponent

Parameters:

c - the Color to use for the background.

See Also:

anchor

toString

public java.lang.String toString()

Get a text description of this SelectNode.

Overrides:

toString in class java.awt.Component

Returns:

a text description of this SelectNode.

adjustPositionForNib

public static void adjustPositionForNib(java.awt.Point location,
                                        java.awt.Dimension size,
                                        java.awt.Point p,
                                        int nibType)

Adjust location and size arguments to reflect changes to a Rectangle based upon the proposed new location of this SelectNib.

Parameters:

location - the resulting coordinates of the rectangle.

size - the resulting dimensions of the rectangle.

p - the new coordinates of the nib.

nibType - which nib.