oracle.jdeveloper.uieditor.uicanvas

Interface SelectionEffects

public interface SelectionEffects

SelectionEffects encapsulates the handling of SelectNib instances upon an associated UICanvas. SelectionEffects are typically used by a LayoutAssistant to render visual feedback to the user representing the current selection.

See Also:

UICanvas, SelectNib

Method Summary

Modifier and Type	Method and Description
boolean	areVisible() Determine whether or not any of the SelectNib instances are currently set to visible.
SelectNib[]	getSelectNibs(int count) Get an array of SelectNib which may then be customized with respect to color, visibility, etc.
UICanvas	getUICanvas() Get the associated UICanavas.
void	hideAll() Hide all existing SelectNib instances.
SelectNib	hitTest(java.awt.Point point) Determine whether or not a given Point falls within the boundaries of a valid SelectNib.
void	moveNib(SelectNib nib, int x, int y) Move the given SelectNib to the given coordinates relative to the surface of the associated UICanvas.

Method Detail

getSelectNibs

SelectNib[] getSelectNibs(int count)

Get an array of SelectNib which may then be customized with respect to color, visibility, etc. Recycles existing SelectNib instances such that each call will return the same objects as the last to the extent possible.

Parameters:

count - the number of SelectNib instances requested

Returns:

an array of count SelectNib instances

moveNib

void moveNib(SelectNib nib,
             int x,
             int y)

Move the given SelectNib to the given coordinates relative to the surface of the associated UICanvas.

Parameters:

nib - the SelectNib to move

x - the x coordinate relative to the UICanvas design surface

y - the y coordinate relative to the UICanvas design surface

areVisible

boolean areVisible()

Determine whether or not any of the SelectNib instances are currently set to visible.

Returns:

true if any of the SelectNib instances are visible

hideAll

void hideAll()

Hide all existing SelectNib instances. The number of existing SelectNib instances may be greater than the last number requested via getSelectNibs.

getUICanvas

UICanvas getUICanvas()

Get the associated UICanavas.

Returns:

the associated UICanvas

hitTest

SelectNib hitTest(java.awt.Point point)

Determine whether or not a given Point falls within the boundaries of a valid SelectNib.

Parameters:

point - position relative to the UICanvas design surface

Returns:

the SelectNib under the given point, else null