Extension SDK 9.0.5

oracle.jdeveloper.uieditor.uicanvas
Interface UICanvas

All Superinterfaces:
ControllerProvider, Explorer, Helpable, UIEditorCanvas, View

public interface UICanvas
extends UIEditorCanvas

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

See Also:
UIEditorCanvas

Field Summary
 
Fields inherited from interface oracle.ide.explorer.Explorer
CLOSED, HIDDEN, SHOWN
 
Fields inherited from interface oracle.ide.addin.View
PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Method Summary
 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.
 java.awt.Point getAbsoluteLocation(java.awt.Component component)
          Get the location of the given Component relative to the design canvas.
 BoxEffects getBoxEffects()
          Get a BoxEffects object associated with this UICanvas.
 LayoutAssistant getLayoutAssistant(CmtModelNode node)
          Get the associated LayoutAssistant for the given CmtModelNode.
 SelectionEffects getSelectionEffects()
          Get a SelectionEffects object associated with this UICanvas.
 
Methods inherited from interface oracle.jdeveloper.uieditor.UIEditorCanvas
getDefaultFocusComponent, getModel, getUIEditor, setModel
 
Methods inherited from interface oracle.ide.explorer.Explorer
getTitle, setContext, setOwner, stateChanged
 
Methods inherited from interface oracle.ide.addin.View
activate, addViewListener, addViewSelectionListener, close, deactivate, getContext, getContext, getContextMenu, getGUI, getId, getSelection, getToolbar, isVisible, owner, removeViewListener, removeViewSelectionListener, setToolbarVisible, show, updateTitle, updateVisibleActions
 
Methods inherited from interface oracle.ide.addin.ControllerProvider
getController
 
Methods inherited from interface oracle.ide.help.Helpable
getHelpInfo
 

Method Detail

getBoxEffects

public BoxEffects getBoxEffects()
Get a BoxEffects object associated with this UICanvas.

Returns:
a BoxEffects object whose manipulations apply to this UICanvas

getSelectionEffects

public SelectionEffects getSelectionEffects()
Get a SelectionEffects object associated with this UICanvas.

Returns:
a SelectionEffects object whose manipulations apply to this UICanvas

getLayoutAssistant

public 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 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 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.

Extension SDK

 

Copyright © 1997, 2004, Oracle. All rights reserved.