Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.7.0)

E13403-08

oracle.jdeveloper.uieditor
Class UIEditor

java.lang.Object
  extended by oracle.ide.view.View
      extended by oracle.ide.editor.Editor
          extended by oracle.jdeveloper.uieditor.UIEditor
All Implemented Interfaces:
ControllerProvider, Helpable, LayoutSelector, Observer

public abstract class UIEditor
extends Editor

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.


Field Summary
 
Fields inherited from class oracle.ide.editor.Editor
_addin, _context, ATTRIBUTE_BACKGROUND_COLOR, ATTRIBUTE_CUSTOM_HORIZONTAL_SCROLLBAR, ATTRIBUTE_CUSTOM_VERTICAL_SCROLLBAR, ATTRIBUTE_DELAY_PALETTE_LOAD, ATTRIBUTE_HORIZONTAL_BLOCK_INCREMENT, ATTRIBUTE_HORIZONTAL_SCROLLBAR_POLICY, ATTRIBUTE_HORIZONTAL_UNIT_INCREMENT, ATTRIBUTE_MENU_ID, ATTRIBUTE_OLD_EDITOR, ATTRIBUTE_SCROLLABLE, ATTRIBUTE_VERTICAL_BLOCK_INCREMENT, ATTRIBUTE_VERTICAL_SCROLLBAR_POLICY, ATTRIBUTE_VERTICAL_UNIT_INCREMENT, CUSTOM_BORDER, PROPERTY_FIXED_BOTTOM_MARGIN, PROPERTY_FIXED_LEFT_MARGIN, PROPERTY_FIXED_RIGHT_MARGIN, PROPERTY_FIXED_TOP_MARGIN, PROPERTY_SCROLLABLE_LEFT_MARGIN, PROPERTY_SCROLLABLE_TOP_MARGIN
 
Fields inherited from class oracle.ide.view.View
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Constructor Summary
protected UIEditor()
          Constructor.
 
Method Summary
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.Editor
addPreferredLayoutListener, addPropertyChangeListener, close, editorHidden, editorShown, firePropertyChangeEvent, getBottomComponent, getContext, getContextMenu, getController, getDependentNodes, getDisplayName, getEditorAddin, getFixedBottomMargin, getFixedLeftMargin, getFixedRightMargin, getFixedTopMargin, getMiniToolbar, getPreferredLayoutBaseName, getPreferredLayoutURL, getScrollableLeftMargin, getScrollableTopMargin, getTabDescription, getTabIcon, getTabLabel, getTitleLabel, getType, initializeActiveLayout, initializeLayout, isReady, loadSettings, newId, open, prepareForSaving, removePreferredLayoutListener, removePropertyChangeListener, saveSettings, setContext, setEditorAddin, setEditorAttribute, setPreferredLayoutBaseName, setPreferredLayoutURL, setType
 
Methods inherited from class oracle.ide.view.View
activate, addViewListener, addViewSelectionListener, addViewStateListener, deactivate, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getGUI, getId, getSelection, getSelectionFromUI, getTabName, getToolbar, getViewWithoutDecoration, isVisible, loadLayout, loadManifestToolbar, loadManifestToolbar, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, saveLayout, scheduleUpdateSelection, setId, setOwner, 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
 
Methods inherited from interface oracle.ide.model.Observer
update
 

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

getDefaultFocusComponent

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

Overrides:
getDefaultFocusComponent in class Editor
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 View
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)
Overrides:
getEditorAttribute in class Editor
Parameters:
attribute - takes values from ATTRIBUTE_ constants.
Returns:
the value for the specified attribute.

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.7.0)

E13403-08

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