|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.Ide
public final class Ide
This class is responsible for coordinating startup of the IDE.
Method Summary | |
---|---|
static void |
addIdeListener(IdeListener l)
Deprecated. |
static boolean |
canRestart()
Get whether the IDE is capable of being restarted. |
static int |
createCmdID(java.lang.String commandName)
|
static java.lang.Integer |
findCmdID(java.lang.String commandName)
If the specified String is associated with a command ID number, that number is returned as an Integer. |
static java.lang.String |
findCmdName(int cmdID)
Find the command name associated with the specified id. |
static int |
findOrCreateCmdID(java.lang.String commandName)
This is the primary method that addins should use to allocate a command ID for actions that will be handled by a Controller . |
static Project |
getActiveProject()
Returns the currently active Project . |
static Workspace |
getActiveWorkspace()
Returns the currently active Workspace . |
static java.lang.String |
getBinDirectory()
Gets the directory the product was started from. |
static Project |
getDefaultProject()
Gets the default project node |
static Workspace |
getDefaultWorkspace()
Gets the default Workspace |
static DTCache |
getDTCache()
Gets the DTCache |
static EnvironOptions |
getEnvironOptions()
Gets the EnvironOptions |
static java.lang.String |
getHomeDirectory()
Deprecated. since 11.0 - use getProductHomeDirectory() instead. |
static javax.swing.ActionMap |
getIdeActionMap()
Returns an ActionMap for the IDE's accelerator keys. |
static IdeArgs |
getIdeArgs()
Gets the {@link IdeArgs) |
static Controller |
getIdeController()
Internal only. |
static javax.swing.InputMap |
getIdeInputMap()
Returns an InputMap for the IDE's accelerator keys. |
static IdeProperties |
getIdeProperties()
Gets the IdeProperties instance |
static java.lang.String |
getInstallDirectory(java.io.File systemDir)
Gets the install directory |
static KeyStrokeContextRegistry |
getKeyStrokeContextRegistry()
Gets the KeyStrokeContextRegistry |
static NavigatorWindow |
getLastActiveNavigator()
Gets the NavigatorWindow of the last active navigator. |
static java.lang.String |
getLibDirectory()
Retrieves the IDE lib directory. |
static java.util.Map |
getMacros()
Gets the default Map of the macros in use by the IDE. |
static IdeMainWindow |
getMainWindow()
Gets the IdeMainWindow instance. |
static Menubar |
getMenubar()
Gets the menubar . |
static java.lang.String |
getOracleHomeDirectory()
Returns the Oracle products install directory. |
static java.lang.String |
getProductHomeDirectory()
Gets the path of the product home directory. |
static java.lang.String |
getProductID()
Gets the extension ID of the current product. |
static java.lang.String |
getProductVersion()
Gets a human readable description of the product name and version. |
static java.lang.String |
getProgramName()
Return the IDE product's full program name. |
static java.lang.String |
getProgramShortName()
Returns the short name of the product. |
static java.lang.String |
getProperty(java.lang.String key)
Gets the IDE property indicated by the specified key. |
static java.lang.String |
getProperty(java.lang.String key,
java.lang.String def)
Gets the IDE property indicated by the specified key. |
static IdeSettings |
getSettings()
Gets the IdeSettings |
static StatusBar |
getStatusBar()
Gets the StatusBar instance. |
static IdeSystem |
getSystem()
Gets the user's system. |
static java.lang.String |
getSystemDirectory()
|
static Toolbar |
getToolbar()
Gets the Toolbar . |
static java.lang.String |
getTrueUserHomeDirectory()
Get the user's actual home directory, represented by the "user.home" system property. |
static java.lang.String |
getUserHomeDirectory()
Deprecated. since 11.0 - Use getUserSettingsDirectory() to
get the location where user settings are stored, or getTrueUserHomeDirectory()
to get the user's actual home directory. |
static java.lang.String |
getUserSettingsDirectory()
Gets the directory that contains user specific settings. |
static float |
getVersion()
Gets the current IDE version number. |
static ComponentVersionManager |
getVersionInfo()
Gets the ComponentVersionManager |
static WaitCursor |
getWaitCursor()
Gets the WaitCursor |
static java.lang.String |
getWorkDirectory()
Gets the full path name of the current work directory. |
static Workspaces |
getWorkspaces()
Gets the workspaces. |
static IdeCore |
installNullCore()
Installs a null instance core into the ide. |
static boolean |
isQuitting()
Returns true when the IDE is quitting. |
static boolean |
isRunning()
Returns true when the IDE is running, even if the IDE
is just starting or quitting. |
static boolean |
isStarting()
Returns true when the IDE is starting up. |
static HistoryList |
loadHistoryList(java.lang.String name)
Loads the history list |
static int |
quit()
Perform a controlled shut down of the IDE. |
static int |
quit(IdeAction action,
Context context)
Perform a controlled shut down of the IDE. |
static void |
removeIdeListener(IdeListener l)
Removes a listener to the IDE. |
static void |
restart()
Restarts the product with the exact same arguments as this instance of the product was started with. |
static void |
setActiveProject(Project project)
Sets the active project |
static void |
setActiveWorkspace(Workspace workspace)
Sets the active workspace |
static java.lang.String |
setProperty(java.lang.String key,
java.lang.String value)
Sets the IDE property indicated by the specified key. |
static void |
startup(IdeArgs args)
Used to startup the IDE |
static void |
startup(IdeCore core)
Used to startup the IDE |
static void |
uninstallNullCore(IdeCore oldCore)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static IdeCore installNullCore()
public static void uninstallNullCore(IdeCore oldCore)
public static float getVersion()
However, we do guarantee that for builds a and b of JDeveloper, where b is a later minor release of the same major release or a later major release that b.getVersion() > a.getVersion().
For a more accurate representation of the product version, use
getProductVersion()
.
public static boolean isRunning()
true
when the IDE is running, even if the IDE
is just starting or quitting.
public static IdeMainWindow getMainWindow()
IdeMainWindow
instance.
public static IdeArgs getIdeArgs()
public static java.lang.String getProductID()
public static java.lang.String getProductVersion()
public static java.lang.String getBinDirectory()
product home
.
public static java.lang.String getHomeDirectory()
getProductHomeDirectory()
instead.
public static java.lang.String getProductHomeDirectory()
getOracleHomeDirectory()
that contains the
current product, for example jdev or sqldeveloper.
public static java.lang.String getOracleHomeDirectory()
public static java.lang.String getLibDirectory()
public static java.lang.String getUserHomeDirectory()
getUserSettingsDirectory()
to
get the location where user settings are stored, or getTrueUserHomeDirectory()
to get the user's actual home directory.
public static java.lang.String getUserSettingsDirectory()
On Windows: c:\Documents and Settings\jsmith\Application Data\Oracle\SQLDeveloper On Mac: /Users/jsmith/Libary/Application Support/JDeveloper On Linux: /home/jsmith/.owb
public static java.lang.String getTrueUserHomeDirectory()
getUserHomeDirectory()
.
public static java.lang.String getSystemDirectory()
public static java.lang.String getWorkDirectory()
Important: the work directory is not a fixed location. It starts off in a standard place (usually "mywork" under the user directory). However, as new applications are created, the work directory will change. You should not rely on this method returning the same location between calls.
public static java.lang.String getProgramName()
public static java.lang.String getProgramShortName()
public static IdeProperties getIdeProperties()
IdeProperties
instance
public static java.lang.String getProperty(java.lang.String key)
key
- the name of the IDE property.
null
if there is no property with that key.setProperty(java.lang.String, java.lang.String)
public static java.lang.String getProperty(java.lang.String key, java.lang.String def)
key
- the name of the IDE property.def
- a default value.
setProperty(java.lang.String, java.lang.String)
public static java.lang.String setProperty(java.lang.String key, java.lang.String value)
key
- the name of the IDE property.value
- the value of the IDE property.
null
if it did not have one.getProperty(String)
public static WaitCursor getWaitCursor()
WaitCursor
public static ComponentVersionManager getVersionInfo()
ComponentVersionManager
public static IdeSettings getSettings()
IdeSettings
public static KeyStrokeContextRegistry getKeyStrokeContextRegistry()
KeyStrokeContextRegistry
public static EnvironOptions getEnvironOptions()
EnvironOptions
public static DTCache getDTCache()
DTCache
public static IdeSystem getSystem()
public static Workspaces getWorkspaces()
Workspaces
object when there are no workspaces
available.public static Workspace getActiveWorkspace()
Workspace
. If there is
no currently active Workspace
, this method will return
null.
public static void setActiveWorkspace(Workspace workspace)
workspace
- to set as the active workspacepublic static Project getActiveProject()
Project
. If there is
no currently active Project
, this method will return
null.
public static void setActiveProject(Project project)
project
- to set as the active projectpublic static Project getDefaultProject()
public static Workspace getDefaultWorkspace()
Workspace
public static void addIdeListener(IdeListener l)
IdeListener
should no longer be needed.
with deferred loading and OSGi.
Adds a listener to the IDE.
IdeListener
public static void removeIdeListener(IdeListener l)
IdeListener
public static javax.swing.InputMap getIdeInputMap()
public static javax.swing.ActionMap getIdeActionMap()
public static boolean isQuitting()
true
when the IDE is quitting.
public static boolean isStarting()
true
when the IDE is starting up. Returns
false
all other times.
public static java.lang.Integer findCmdID(java.lang.String commandName)
public static java.lang.String findCmdName(int cmdID)
public static int createCmdID(java.lang.String commandName)
public static int findOrCreateCmdID(java.lang.String commandName)
Controller
. For the specified
String, this method will return either an existing command ID number
if such a number has already been allotted for the String or a
new command ID.
public static java.util.Map getMacros()
Map
of the macros in use by the IDE.
public static int quit(IdeAction action, Context context)
action
- the action to shut down with.context
- the context in which to shut downpublic static int quit()
public static Menubar getMenubar()
menubar
. The menubar is a singleton object
used to add menus to the ide main window.
public static Toolbar getToolbar()
Toolbar
. The toolbar is a singleton
object used to add tools to the ide main window toolbar.
public static StatusBar getStatusBar()
StatusBar
instance.
public static NavigatorWindow getLastActiveNavigator()
NavigatorWindow
of the last active navigator.
public static HistoryList loadHistoryList(java.lang.String name)
name
-
public static void startup(IdeArgs args)
args
- public static void startup(IdeCore core)
public static Controller getIdeController()
public static java.lang.String getInstallDirectory(java.io.File systemDir)
systemDir
-
public static boolean canRestart()
Note that a return value of true does not guarantee that a call
to restart()
will be successful. However, it does provide
immediate information about whether restarting is supported at all on the
current platform prior to actually calling restart()
.
public static void restart() throws java.lang.UnsupportedOperationException
canRestart()
.
java.lang.UnsupportedOperationException
- if restarting is not possible.
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |