oracle.jdeveloper.uieditor.uicanvas
Class UICanvas

java.lang.Object
  oracle.ide.view.View
      oracle.ide.explorer.Explorer
          oracle.jdeveloper.uieditor.UIEditorCanvas
              oracle.jdeveloper.uieditor.AbstractCanvas
                  oracle.jdeveloper.uieditor.uicanvas.UICanvas

All Implemented Interfaces:

java.util.EventListener, ContextMenuListener, ControllerProvider, Helpable, ViewSelectionListener

public abstract class UICanvas
extends AbstractCanvas

UICanvas represents a design canvas to be hosted by the UIEditor when manipulating GUI objects.

See Also:

AbstractCanvas

Field Summary

Fields inherited from class oracle.jdeveloper.uieditor.AbstractCanvas

editor, model, SERIALIZE_ACTION, SERIALIZE_ITEM, X_MARGIN, Y_MARGIN

Fields inherited from class oracle.ide.explorer.Explorer

CLOSED, defaultNode, defaultProject, defaultWorkspace, HIDDEN, SHOWN

Fields inherited from class oracle.ide.view.View

EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Constructor Summary

UICanvas()

Method Summary

abstract CmtModelNode	findContainerNode(CmtModelNode[] excludeNodes, java.awt.Point absoluteLocation, java.awt.Point relativeLocation, CmtModelNode preferredAncestor) Find the nearest container ancestor for a given point, providing relative location of that point within the ancestor.
abstract java.awt.Point	getAbsoluteLocation(java.awt.Component component) Get the location of the given Component relative to the design canvas.
abstract BoxEffects	getBoxEffects() Get a BoxEffects object associated with this UICanvas.
abstract LayoutAssistant	getLayoutAssistant(CmtModelNode node) Get the associated LayoutAssistant for the given CmtModelNode.
abstract SelectionEffects	getSelectionEffects() Get a SelectionEffects object associated with this UICanvas.

Methods inherited from class oracle.jdeveloper.uieditor.AbstractCanvas

close, getContext, getController, getDefaultFocusComponent, getModel, getSelectionFromUI, getUIEditor, handleDefaultAction, menuWillHide, menuWillShow, setContext, setModel, setOwner, stateChanged, viewSelectionChanged

Methods inherited from class oracle.ide.explorer.Explorer

getContextMenu, getTitle

Methods inherited from class oracle.ide.view.View

activate, addViewListener, addViewSelectionListener, addViewStateListener, deactivate, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getGUI, getHelpInfo, getId, getSelection, getTabName, getToolbar, getViewWithoutDecoration, isVisible, loadLayout, loadManifestToolbar, loadManifestToolbar, newId, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, saveLayout, scheduleUpdateSelection, setId, setToolbarVisible, show, toString, updateSelection, updateSelectionImpl, updateTitle, updateToolbarActions, updateVisibleActions, updateVisibleActions

Methods inherited from class java.lang.Object

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

Constructor Detail

UICanvas

public UICanvas()

Method Detail

getBoxEffects

public abstract BoxEffects getBoxEffects()

Get a BoxEffects object associated with this UICanvas.

Returns:

a BoxEffects object whose manipulations apply to this UICanvas

getSelectionEffects

public abstract SelectionEffects getSelectionEffects()

Get a SelectionEffects object associated with this UICanvas.

Returns:

a SelectionEffects object whose manipulations apply to this UICanvas

getLayoutAssistant

public abstract LayoutAssistant getLayoutAssistant(CmtModelNode node)

Get the associated LayoutAssistant for the given CmtModelNode.

Parameters:

node - the CmtModelNode whose associated LayoutAssistant is requested

Returns:

the LayoutAssistant associated with node

getAbsoluteLocation

public abstract java.awt.Point getAbsoluteLocation(java.awt.Component component)

Get the location of the given Component relative to the design canvas.

Parameters:

component - the Component whose location is desired

Returns:

the location of Component relative to the canvas surface

findContainerNode

public abstract CmtModelNode findContainerNode(CmtModelNode[] excludeNodes,
                                               java.awt.Point absoluteLocation,
                                               java.awt.Point relativeLocation,
                                               CmtModelNode preferredAncestor)

Find the nearest container ancestor for a given point, providing relative location of that point within the ancestor. Allows a list of exclusion nodes to be passed to filter out undesired nodes & their descendants. Providing a preferred ancestor allows a more distant ancestor node to be returned rather than the nearest one.

Parameters:

excludeNodes - array of CmtModelNode not to be considered

absoluteLocation - a location relative to the canvas surface

relativeLocation - output variable for point relative to ancestor

preferredAncestor - nearest ancestor to consider

Returns:

nearest container ancestor.