Extension SDK 10.1.2

oracle.ide.addin
Interface Controller

All Known Implementing Classes:
AbstractCanvasController, AbstractLogManager, CodeEditorController, DockStation, EditorManager, FileOpenHistory, JCompiler, JProjectStructureController, LogManager, MultiManager, ObjectGalleryAddin, PrintManager, VCSController, WindowManager, WizardManager

public interface Controller

Each View has an associated Controller. Controllers receive requests to handle the commands associated with user actions. The controller's handleEvent method gets called with the appropriate Command specified. If the Controller does not handle the requested command it delegates the Command to a supervising Controller. Controllers are also responsible for determining the availability of a specific command. The update method is called to do just that.

See Also:
oracle.jdeveloper.ide.Command, oracle.jdeveloper.ide.IdeAction, oracle.jdeveloper.ide.View

Method Summary
 boolean handleEvent(IdeAction action, Context context)
          This method is called when a user interaction with a View triggers the execution of a command.
 boolean update(IdeAction action, Context context)
          This method updates the enabled status of the specified action within the specified context.
 

Method Detail

handleEvent

public boolean handleEvent(IdeAction action,
                           Context context)
This method is called when a user interaction with a View triggers the execution of a command.

Parameters:
action - action whose command is to be executed.
Returns:
true if the controller handles the specified command.

update

public boolean update(IdeAction action,
                      Context context)
This method updates the enabled status of the specified action within the specified context. It should generally be called on the controller associated with the active view to allow that controller to take the first crack at determining its enabled status. If that controller wants to update its enabled status, it does so and returns true to indicate that further controllers do not need to be consulted. If the controller does not deal with setting the enabled status of an action, it delegates the request to its supervising controller, all the way up to the Ide. The Ide has a special implementation of update(xx) that further delegates the request to root controllers, until one of them returns true indicating the request was handled by the controller.

Parameters:
action - action whose command is to be executed.
context - the current context
Returns:
true if the controller handles the specified command.

Extension SDK

 

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