|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.4.0) E13403-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.view.View
public abstract class View
View
components display information to the user. A view obtains
the data from the model. There can be multiple views of the model.
Each View
has an associated Controller
.
Controllers receive requests to handle the commands associated with user
interaction with the view.
A view can own other views. For example, all views are owned by the
IdeMainWindow
view.
IdeMainWindow
Field Summary | |
---|---|
static Element[] |
EMPTY_SELECTION
|
static java.lang.String |
PROJECT_PROP
|
static java.lang.String |
VISIBLE_PROP
|
static java.lang.String |
WORKSPACE_PROP
|
Constructor Summary | |
---|---|
protected |
View()
|
protected |
View(java.lang.String viewId)
|
Method Summary | |
---|---|
void |
activate()
|
void |
addViewListener(ViewListener l)
|
void |
addViewSelectionListener(ViewSelectionListener l)
|
void |
addViewStateListener(ViewStateListener l)
Registers the specified ViewStateListener with this View
instance to be called back when a ViewStateEvent occurs. |
void |
close()
|
void |
deactivate()
Cleans up after this view stops being the active view. |
void |
fireViewCollapsed()
Fires the ViewStateEvent.viewCollapsed(..) event. |
void |
fireViewExpanded()
Fires the ViewStateEvent.viewExpanded(..) event. |
protected void |
fireViewSelectionChanged(ViewSelectionEvent e)
|
Context |
getContext()
|
Context |
getContext(java.util.EventObject event)
|
ContextMenu |
getContextMenu()
|
Controller |
getController()
Get the Controller associated with this view. |
abstract java.awt.Component |
getGUI()
|
HelpInfo |
getHelpInfo()
|
java.lang.String |
getId()
Unique id identifying this view. |
Element[] |
getSelection()
|
protected Element[] |
getSelectionFromUI()
This method retrieve's the selection in this View directly from the UI. |
java.lang.String |
getTabName()
|
Toolbar |
getToolbar()
Get the toolbar associated with this view. |
View |
getViewWithoutDecoration()
Returns the View without any decorators. |
boolean |
isVisible()
|
void |
loadLayout(PropertyAccess p)
|
static void |
loadManifestToolbar(java.lang.String toolbarId,
Toolbar toolbar)
Installs toolbar buttons for the specified Toolbar . |
static void |
loadManifestToolbar(java.lang.String toolbarId,
Toolbar toolbar,
View view)
Installs toolbar buttons for the specified Toolbar . |
protected java.lang.String |
newId()
Generates a unique view ID. |
View |
owner()
Get the owning View . |
void |
removeViewListener(ViewListener l)
|
void |
removeViewSelectionListener(ViewSelectionListener l)
|
void |
removeViewStateListener(ViewStateListener l)
Unregisters the specified ViewStateListener from this
View instance. |
void |
saveLayout(PropertyAccess p)
|
void |
scheduleUpdateSelection()
A variation of that delays the firing of the
ViewSelectionEvent using a timer delay. |
protected void |
setId(java.lang.String id)
|
protected void |
setOwner(View owner)
|
void |
setToolbarVisible(boolean visible)
|
void |
show()
Shows the view if hidden. |
java.lang.String |
toString()
|
void |
updateSelection()
Subclasses should call this method to update the selection returned from getSelection() and to fire the
ViewSelectionEvent . |
protected void |
updateSelectionImpl(boolean doNotifyOnInvokeLater)
|
void |
updateTitle(java.lang.Object obj)
Called when the view needs to update its title based on the specified object. |
static void |
updateToolbarActions(Toolbar toolbar)
Utility method for updating the actions contained in a toolbar. |
void |
updateVisibleActions()
Method for updating the visible actions associated with this view. |
void |
updateVisibleActions(UpdateMessage updateMessage)
Called when the IDE or an extension requests that the View updates the enabled state of any actions
that are visible on screen. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String VISIBLE_PROP
public static final java.lang.String PROJECT_PROP
public static final java.lang.String WORKSPACE_PROP
public static final Element[] EMPTY_SELECTION
Constructor Detail |
---|
protected View()
protected View(java.lang.String viewId)
Method Detail |
---|
public View getViewWithoutDecoration()
public void saveLayout(PropertyAccess p)
public void loadLayout(PropertyAccess p)
public Controller getController()
ControllerProvider
Controller
associated with this view.
getController
in interface ControllerProvider
public HelpInfo getHelpInfo()
getHelpInfo
in interface Helpable
public final View owner()
View
. View
s can be nested. In
general, View
s should return the IdeMainWindow
as their owner, unless they are nested within another View
.
View
.public void close()
public void show()
public boolean isVisible()
public abstract java.awt.Component getGUI()
public final Context getContext()
public Context getContext(java.util.EventObject event)
event
- event associated with the context.
public ContextMenu getContextMenu()
ContextMenu
, if any.public void activate()
public void deactivate()
public final Element[] getSelection()
public final java.lang.String getId()
NavigatorWindow.Project1
where Project1 is the name component of the project node.
public void updateTitle(java.lang.Object obj)
obj
- the specified object.public void updateVisibleActions(UpdateMessage updateMessage)
View
updates the enabled state of any actions
that are visible on screen. Typically this will involve updating actions that are in visible toolbars. If a
View
contains or manages other nested instances of View
, the outer call to
updateVisibleActions
should propagate inward to call the updateVisibleActions
of all
visible, nested View
s.
updateMessage
- information on what is triggering the update. Implementations may make use of this
information to decide whether or not an update is necessary, since updating the enabled state of a toolbar button
may be a lengthy operation. For example, buttons that control a remote debugger would involve network I/O and
evaluating their updated state could be avoided if the updateMessage indicates that the source of the update is not
relevant to the debugger.public Toolbar getToolbar()
public void setToolbarVisible(boolean visible)
public void addViewListener(ViewListener l)
public void removeViewListener(ViewListener l)
public void addViewSelectionListener(ViewSelectionListener l)
public void removeViewSelectionListener(ViewSelectionListener l)
public final void addViewStateListener(ViewStateListener l)
ViewStateListener
with this View
instance to be called back when a ViewStateEvent
occurs.
l
- The listener to register.public final void removeViewStateListener(ViewStateListener l)
ViewStateListener
from this
View instance.
l
- The listener to unregister.public final void updateSelection()
Subclasses should call this method to update the selection returned from getSelection()
and to fire the
ViewSelectionEvent
. The event is fired synchronously, so this method will block until all listeners have been notified.
See scheduleUpdateSelection()
for a variation that delays selection change notification using a timer
delay.
public final void scheduleUpdateSelection()
A variation of
that delays the firing of the
updateSelection()
ViewSelectionEvent
using a timer delay. This method is useful when multiple selection changes could
possibly occur in rapid sucession. When using this method, notification is not sent until a minimum interval
(around 250 ms) passes without another call to scheduleUpdateSelection() ocurring.
View
's current selection is retrieved from the UI via getSelectionFromUI()
.
public final void updateVisibleActions()
public static final void updateToolbarActions(Toolbar toolbar)
toolbar
- The toolbar whose actions should be updated.public static final void loadManifestToolbar(java.lang.String toolbarId, Toolbar toolbar, View view)
Toolbar
.
toolbarId
- the id of the toolbar to load.toolbar
- the toolbar to install items into.view
- the (optional) view to use. If specified, the toolbar is owned by a view and all actions will only work
with that view's context.public static final void loadManifestToolbar(java.lang.String toolbarId, Toolbar toolbar)
Toolbar
.
toolbarId
- the id of the toolbar to load.toolbar
- the toolbar to install items into.protected Element[] getSelectionFromUI()
protected final void updateSelectionImpl(boolean doNotifyOnInvokeLater)
protected final void setId(java.lang.String id)
protected java.lang.String newId()
public java.lang.String toString()
toString
in class java.lang.Object
protected void setOwner(View owner)
protected final void fireViewSelectionChanged(ViewSelectionEvent e)
public final void fireViewExpanded()
public final void fireViewCollapsed()
public java.lang.String getTabName()
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.4.0) E13403-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |