|
|
Package com.dassault_systemes.catweb.base.util |
Class CommonSupport
|
Class Hierarchy |
java.lang.Object | +-com.dassault_systemes.catweb.base.util.CommonSupport
Class Location |
Class Description |
public class CommonSupport
Class of utilities methods for getting desktop informations.
Field Summary |
boolean | APPLICATION_MODE |
int | MODE_APPLICATION |
int | MODE_HTTPAPPLI |
int | MODE_NOMAD |
int | MODE_APPLET |
TimeZone | TIME_ZONE |
int | WARNING_MESSAGE |
int | ERROR_MESSAGE |
int | INFO_MESSAGE |
Constructor Summary |
Method Summary |
void | removeInstance() |
void | showWaitingCursor() |
void | hideWaitingCursor() |
void | showWaitingMessage(String waitingMessage) |
void | hideWaitingMessage() |
void | destroyAckMessage() |
void | sendNonAckMessage(int boxType, String message) |
String | createCATlet(String catletName) |
String[] | getTypesforFileExtension(String fileExtension) |
String[] | getLabelsforType(String catletType) |
String[] | getInstanceNamesforType(String catletType) |
void | showCATletProperties() |
void | showURL(URL url) |
void | showURL(String url) |
void | showURLInNewWindow(URL url) |
void | showURLInNewWindow(String url) |
void | showCATletHelp() |
Image | getEnoviaIcon() |
String | getCurrentCATletName() |
void | activateCATlet(ICATlet catlet) |
void | activateCATlet(String instanceName) |
void | closeCATlet(ICATlet catlet) |
void | closeCATlet(ICATlet catlet, boolean checkPersistence) |
String | getCurrentDocumentNameOfCATlet(String instanceName) |
void | registerToHelpManager(Component component) |
void | unregisterFromHelpManager(Component component) |
Frame | getMainFrame() |
Frame | getLogonFrame() |
void | setLogonFrame(Frame frame) |
void | addBookmarkInProject(Object data, String projectName) |
void | addBookmarkInProject(String name, Object data, String projectName) |
void | addBookmarkInProject(Object data) |
void | addBookmarkInProject(Object[] dataList) |
void | addBookmarkInProject(String name, Object data) |
void | addBookmarkInProject(String[] nameList, Object[] dataList) |
String | getCurrentProjectName() |
String[] | getAvailableProjectNames() |
Menu | getAvailableProjectNamesMenu() |
Applet | getApplet() |
int | getRunningMode() |
String | getParameter(String paramName) |
float | getVersion() |
String | getLocalDomainName() |
Field Detail |
boolean APPLICATION_MODETrue when desktop is running in Application mode.
int MODE_APPLICATIONDefines the current extended mode of the desktop : Application, HTTP Application, Nomad or Applet.
int MODE_HTTPAPPLI
int MODE_NOMAD
int MODE_APPLET
TimeZone TIME_ZONEtime zone use for the application
int WARNING_MESSAGEDifferent message types
int ERROR_MESSAGE
int INFO_MESSAGE
Constructor Detail |
Method Detail |
void removeInstance()Removes instance
void showWaitingCursor()Informs the webtop to display WAIT cursor.
void hideWaitingCursor()Informs the webtop to stop display WAIT cursor.
void showWaitingMessage(String waitingMessage)Shows a waiting message
waitingMessage
void hideWaitingMessage()Hides the waiting messages frame
void destroyAckMessage()Destroys current message if generated by a sendAckMessage
void sendNonAckMessage(int boxType, String message)Displays a message without acknowledge
boxType
message
String createCATlet(String catletName)Creates CATlet with this name
catletName
String[] getTypesforFileExtension(String fileExtension)Returns an array of CATlet types for the specified file extension Theses CATlets are defined in the 'application.properties' file
fileExtension
String[] getLabelsforType(String catletType)Returns the labels of the catlets for the specified type
catletType
String[] getInstanceNamesforType(String catletType)Returns the names of existing CATlets for the specified type
catletType
void showCATletProperties()Displays a properties editor for current active CATlet and its sub-controller if any
void showURL(URL url)Makes the Webtop display a page defined by the URL given
url
void showURL(String url)Makes the Webtop display a page defined by the relative or full url path given
url
void showURLInNewWindow(URL url)Makes the Webtop display a page defined by the URL given in a new browser window
url
void showURLInNewWindow(String url)Makes the Webtop display a page defined by the relative or full url path given in a new browser window
url
void showCATletHelp()Displays help for current active CATlet.
Image getEnoviaIcon()Gets the little icon that can be used when dialog boxes of the application are iconified. It is also the icon that is displayed on the title bar of NT frames.
String getCurrentCATletName()Returns the name of the current active CATlet.
void activateCATlet(ICATlet catlet)Activates the specified catlet.
catlet
void activateCATlet(String instanceName)Activates the catlet specified by its instance name
instanceName
void closeCATlet(ICATlet catlet)Closes a CATlet. If catlet implements PersistentCATlet the isDirty method will be called to check if it need to be saved or not before being closed.
catlet
void closeCATlet(ICATlet catlet, boolean checkPersistence)Closes a CATlet. If flag is set to true and catlet implements PersistentCATlet the isDirty method will be called to check if it need to be saved or not before being closed. If flag is set to false catlet is removed wether it needs to be saved or not.
catlet
checkPersistence
String getCurrentDocumentNameOfCATlet(String instanceName)Returns the name of the current document loaded in the CATlet specified by its instance name.
instanceName
void registerToHelpManager(Component component)Registers a component to the HelpManager so that any key action as F1 or Shift+F1 are taken into acount and trigger the corresponding help action.
component
void unregisterFromHelpManager(Component component)Unregisters a component that was previously registered to the HelpManager
component
Frame getMainFrame()Returns the application main frame so that dialog box can attach themselves under this frame
Frame getLogonFrame()
void setLogonFrame(Frame frame)
void addBookmarkInProject(Object data, String projectName)Adds the following Object inside the project specfied by its name.
data
projectName
void addBookmarkInProject(String name, Object data, String projectName)Adds the following Object inside the project specfied by its name. The data will be bookmarked with the specified name
name
data
projectName
void addBookmarkInProject(Object data)Adds the following Object in a project chosen interactively by the user.
data
void addBookmarkInProject(Object[] dataList)Adds the following list of Object in a project chosen interactively by the user.
dataList
void addBookmarkInProject(String name, Object data)Adds the following Object in a project chosen interactively by the user. The data will be bookmarked with the specified name
name
data
void addBookmarkInProject(String[] nameList, Object[] dataList)Adds the following list of Objects in a project chosen interactively by the user. The data will be bookmarked with the specified name (nameList[i] is the bookmark name for dataList[i])
nameList
dataList
String getCurrentProjectName()Returns the name of the current selected project.
String[] getAvailableProjectNames()Returns the list of available project names.
Menu getAvailableProjectNamesMenu()Returns a menu with the list of available project names.
Applet getApplet()Returns the applet used to start the application. May be null if application was launched as a standalone application.
int getRunningMode()Returns the current desktop mode:
String getParameter(String paramName)Returns the specified launch argument. This method encapsulate System.getProperty and Applet.getParameter.
paramName
float getVersion()Returns the current version number of the application.
String getLocalDomainName()Returns the domain name of the local host.