|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 2 (11.1.2.2.0) E17494-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.alm.view.application.ViewManager
public abstract class ViewManager
The ViewManager
is a singleton class exposing TPC client related service to connector writer. Connector writer can utilize these API to do corresponding customized UI controller work during the connector implementation. For example connector writer can use it in a customized listener code to access current IDE, current connector, and performing ui actions like (OpenWorkItemInEditor()). etc.
For more details on how to use the ViewManager, please refer to TPC connector implementation guideline.
Constructor Summary | |
---|---|
ViewManager() |
Method Summary | |
---|---|
abstract WorkItemConnector |
getCurrentConnector(RenderingContext rcontext) |
abstract java.net.URL |
getCurrentPageURL(RenderingContext rcontext) |
abstract java.lang.String |
getCurrentWIRepositoryId(RenderingContext rcontext) |
abstract java.lang.String |
getCurrentWIRepositoryName(RenderingContext rcontext) |
abstract WorkItem |
getCurrentWorkItem(RenderingContext rcontext) |
abstract java.lang.String |
getCurrentWorkItemType(RenderingContext rcontext) |
abstract AlmELContext |
getELContext(RenderingContext rcontext) |
abstract javax.swing.JFrame |
getIDEMain() |
static ViewManager |
getInstance() |
abstract boolean |
isCurrentEditorDirty(RenderingContext rcontext) |
abstract void |
markCurrentEditorDirty(RenderingContext rcontext, boolean dirty) |
abstract void |
OpenPageInEditor(java.net.URL url) |
abstract void |
OpenPageInEditor(java.net.URL url, java.util.Map params) |
abstract void |
OpenTPCPageInEditor(java.lang.String relpath) |
abstract void |
OpenWorkItemInEditor(WorkItem item, java.lang.String wiType, java.lang.String repName, java.lang.String reposId) |
abstract void |
refreshWorkItemDetailUI(RenderingContext rcontext) |
static void |
setInstance(ViewManager vmgr) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ViewManager()
Method Detail |
---|
public static ViewManager getInstance()
public abstract AlmELContext getELContext(RenderingContext rcontext)
rcontext
- The renderingContext Object for current page.public abstract javax.swing.JFrame getIDEMain()
public abstract WorkItemConnector getCurrentConnector(RenderingContext rcontext)
rcontext
- The renderingContext Object for current page.public abstract java.lang.String getCurrentWIRepositoryName(RenderingContext rcontext)
rcontext
- the RenderingContext object for current page.public abstract java.lang.String getCurrentWIRepositoryId(RenderingContext rcontext)
rcontext
- The RenderingContext obejct for current page.public abstract java.net.URL getCurrentPageURL(RenderingContext rcontext)
rcontext
- The renderingContext Object for current page.public abstract boolean isCurrentEditorDirty(RenderingContext rcontext)
rcontext
- The renderingContext Object for current page.public abstract void markCurrentEditorDirty(RenderingContext rcontext, boolean dirty)
rcontext
- The renderingContext Object for current page.dirty
- The dirty status to be assigned to current editor node.public abstract void OpenTPCPageInEditor(java.lang.String relpath)
relpath
- the TPC page relative path in current connector META-INF/pages directory.
This API will open the page with the specific page path. The page path can be in following format:
"/path/pagename.tpcx?name=value&...." "/repostName/witype/wiid.wid"
That means corresponding page xml will be put under the current fold path under the META-INF directory in current connector.
public abstract void OpenPageInEditor(java.net.URL url)
url
- The URL object
This API will open the page with the specific URL object in an editor tab in the corresponding IDE that the TPC client installed.
The URL can be in any of following format:
"alm:/repositoryName/workitemType/workitemId.wid"; "alm:/repositoryName/pagerelpath.tpcx" or "alm:/pagerelpath.tpcx?repository=repsName"
All above URL will be result opening the page in a TPC editor node
It also support the default browser opening an URL starting with "http" and "ftp", it will launch the default browser on the TPC client to open it.
public abstract void OpenPageInEditor(java.net.URL url, java.util.Map params)
url
- The URL objectparams
- Extra params to be passed to current page, these params will be stored in the RenderingContext object of current page during the page rendering process.public abstract java.lang.String getCurrentWorkItemType(RenderingContext rcontext)
rcontext
- The renderingContext Object for current page.public abstract WorkItem getCurrentWorkItem(RenderingContext rcontext)
rcontext
- The renderingContext Object for current page.public abstract void OpenWorkItemInEditor(WorkItem item, java.lang.String wiType, java.lang.String repName, java.lang.String reposId)
item
-wiType
-repName
-reposId
-public abstract void refreshWorkItemDetailUI(RenderingContext rcontext)
public static void setInstance(ViewManager vmgr)
vmgr
- Set the thread local ViewManager object.
Note: this API is used internal only.
|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 2 (11.1.2.2.0) E17494-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |