oracle.jdeveloper.uieditor.uicanvas
Class BoxEffects

java.lang.Object
  oracle.jdeveloper.uieditor.uicanvas.BoxEffects

public final class BoxEffects
extends java.lang.Object

BoxEffects encapsulates the facilities for drawing boxes upon an associated UICanvas instance. BoxEffects are typically used by a LayoutAssistant to render visual feedback to the user during such operations a creation, resize, and drag.

See Also:

UICanvas, LayoutAssistant

Field Summary

static int	DRAG Style ID indicating drag visuals.
static int	SELECT Style ID indicating selection region.
static int	THICK_GRID Style ID indicating thick outer boundry visuals.
static int	THIN_GRID Style ID indicating thin inner boundry visuals.

Constructor Summary

BoxEffects(java.awt.Container container)
Constructor.

Method Summary

boolean	hide(int i) Hide the box identified by the given identifier.
void	hideAll() Hide all visible boxes.
void	show(int i, java.awt.Point location, java.awt.Dimension size, int style) Display a box identified by i at the given location, of the given size and using the given style.

Methods inherited from class java.lang.Object

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

Field Detail

SELECT

public static final int SELECT

Style ID indicating selection region.

See Also:

Constant Field Values

DRAG

public static final int DRAG

Style ID indicating drag visuals.

See Also:

Constant Field Values

THICK_GRID

public static final int THICK_GRID

Style ID indicating thick outer boundry visuals.

See Also:

Constant Field Values

THIN_GRID

public static final int THIN_GRID

Style ID indicating thin inner boundry visuals.

See Also:

Constant Field Values

Constructor Detail

BoxEffects

public BoxEffects(java.awt.Container container)

Constructor.

Parameters:

container - owner upon which our effects are to be parented.

Method Detail

show

public void show(int i,
                 java.awt.Point location,
                 java.awt.Dimension size,
                 int style)

Display a box identified by i at the given location, of the given size and using the given style. When drawing one or more boxes for simultaneous display, sequential identifiers beginning with 0 should be used. Reusing the same identifier will result in the existing box being reinitialized. There will always be enough boxes instantiated to support the identifier provided (e.g. if given 100, then 100 boxes will be instantiated and the 100th will be displayed.

Parameters:

i - the identifier of the box

location - the location to draw the box

size - the size of the box to draw

style - the style of box to draw.

hide

public boolean hide(int i)

Hide the box identified by the given identifier.

Parameters:

i - the identifier of the box to hide.

Returns:

true if the identifier was of a valid box.

hideAll

public void hideAll()

Hide all visible boxes.