Extension SDK 9.0.5

oracle.jdeveloper.uieditor
Class UIEditor

java.lang.Object
  extended byoracle.ide.addin.AbstractView
      extended byoracle.ide.editor.AbstractEditor
          extended byoracle.ide.editor.AbstractFlatEditor
              extended byoracle.jdeveloper.uieditor.UIEditor
All Implemented Interfaces:
ControllerProvider, Editor, FlatEditor, Helpable, LayoutSelector, Observer, View

public abstract class UIEditor
extends AbstractFlatEditor

Editor implementation whose visuals depict the GUI declared in a JavaSourceNode instance. This implementation presents a canvas upon which individual Component instances are parented in their specified layout as derived from the class member declarations and the property set statements found in the jbInit method.

Whenever this Editor is the active View, it will host additional menus in the View menu of the main menubar. A context menu is also offered allowing quick access to some actions.


Nested Class Summary
 
Nested classes inherited from class oracle.ide.editor.AbstractEditor
AbstractEditor.LayoutData
 
Field Summary
 
Fields inherited from class oracle.ide.editor.AbstractEditor
_context, _editorFrame, CUSTOM_BORDER
 
Fields inherited from class oracle.ide.addin.AbstractView
owner, SEPARATOR, viewListeners, viewSelectionListeners
 
Fields inherited from interface oracle.ide.editor.FlatEditor
ATTRIBUTE_BACKGROUND_COLOR, ATTRIBUTE_HORIZONTAL_BLOCK_INCREMENT, ATTRIBUTE_HORIZONTAL_SCROLLBAR_POLICY, ATTRIBUTE_HORIZONTAL_UNIT_INCREMENT, ATTRIBUTE_MENU_ID, ATTRIBUTE_SCROLLABLE, ATTRIBUTE_VERTICAL_BLOCK_INCREMENT, ATTRIBUTE_VERTICAL_SCROLLBAR_POLICY, ATTRIBUTE_VERTICAL_UNIT_INCREMENT
 
Fields inherited from interface oracle.ide.addin.View
PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Constructor Summary
protected UIEditor()
          Constructor.
 
Method Summary
abstract  void commit(java.lang.String caption)
          Commit any changes made to the CmtComponentSource.
abstract  UIEditorCanvas getActiveCanvas()
          Get the active UIEditorCanvas.
abstract  CmtComponentSource getComponentSource()
          Get the CmtComponentSource being designed.
 java.awt.Component getDefaultFocusComponent()
          Get the default focusable Component associated with this View.
 java.lang.Object getEditorAttribute(java.lang.String attribute)
           
static UIEditorLogPage getErrorLog()
          Get the LogPage in which to write errors.
 HelpInfo getHelpInfo()
          Get the HelpInfo associated with this View.
 
Methods inherited from class oracle.ide.editor.AbstractFlatEditor
addPropertyChangeListener, firePropertyChangeEvent, getFixedLeftMargin, getFixedRightMargin, getFixedTopMargin, getMiniToolbar, getScrollableLeftMargin, getScrollableTopMargin, loadSettings, removePropertyChangeListener, saveSettings
 
Methods inherited from class oracle.ide.editor.AbstractEditor
addPreferredLayoutListener, close, editorHidden, editorShown, getContext, getContext, getContextMenu, getController, getDependentDocuments, getDisplayName, getEditorFrame, getPreferredLayoutBaseName, getPreferredLayoutMap, getPreferredLayoutURL, getTabDescription, getTabIcon, getTabLabel, getTitleLabel, getType, initializeActiveLayout, initializeLayout, isReady, newId, onInitializeLayout, onPreferredLayoutActivate, owner, removePreferredLayoutListener, setContext, setOwner, setPreferredLayoutBaseName, setPreferredLayoutMap, setPreferredLayoutURL, setType
 
Methods inherited from class oracle.ide.addin.AbstractView
activate, addViewListener, addViewSelectionListener, deactivate, fireViewActivated, fireViewClosed, fireViewDeactivated, fireViewSelectionChanged, getId, getSelection, getToolbar, isVisible, loadToolbar, loadToolbar, removeViewListener, removeViewSelectionListener, setId, setOwner, setToolbarVisible, show, updateTitle, updateToolbarActions, updateVisibleActions, updateVisibleActions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface oracle.ide.editor.Editor
editorHidden, editorShown, getDependentDocuments, getTabDescription, getTabIcon, getTabLabel, getTitleLabel, open, setContext, setOwner
 
Methods inherited from interface oracle.ide.addin.Observer
update
 
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.layout.LayoutSelector
addPreferredLayoutListener, getDisplayName, getPreferredLayoutBaseName, getPreferredLayoutURL, getType, initializeActiveLayout, initializeLayout, isReady, removePreferredLayoutListener, setPreferredLayoutBaseName, setPreferredLayoutURL, setType
 

Constructor Detail

UIEditor

protected UIEditor()
Constructor.

Method Detail

getActiveCanvas

public abstract UIEditorCanvas getActiveCanvas()
Get the active UIEditorCanvas.

Returns:
the active UIEditorCanvas.
See Also:
UIEditorCanvas

getComponentSource

public abstract CmtComponentSource getComponentSource()
Get the CmtComponentSource being designed.

Returns:
the CmtComponentSource being designed.
See Also:
CmtComponentSource

commit

public abstract void commit(java.lang.String caption)
Commit any changes made to the CmtComponentSource.

Parameters:
caption - Label to display in the Undo menu item for this operation

getDefaultFocusComponent

public java.awt.Component getDefaultFocusComponent()
Get the default focusable Component associated with this View.

Specified by:
getDefaultFocusComponent in interface Editor
Overrides:
getDefaultFocusComponent in class AbstractEditor
Returns:
the focus Component of the active canvas, else the result of getGUI

getHelpInfo

public HelpInfo getHelpInfo()
Get the HelpInfo associated with this View.

Specified by:
getHelpInfo in interface Helpable
Overrides:
getHelpInfo in class AbstractView
Returns:
the HelpInfo of the active canvas, else defer to superclass.

getErrorLog

public static UIEditorLogPage getErrorLog()
Get the LogPage in which to write errors.

Returns:
the LogPage in which to write errors
See Also:
UIEditorLogPage

getEditorAttribute

public java.lang.Object getEditorAttribute(java.lang.String attribute)
Specified by:
getEditorAttribute in interface FlatEditor
Overrides:
getEditorAttribute in class AbstractFlatEditor

Extension SDK

 

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