|
|
|||||
| Package com.dassault_systemes.catweb.base.catlet |
Interface ICATlet
|
| Class Hierarchy |
com.dassault_systemes.catweb.base.catlet.ICATlet
| Class Location |
| Class Description |
public interface ICATlet
Common interface for any king of CATlet. This interface has two implementations CATlet for awt CATlets and JCATlet for swing CATlets. This interface also exists for infrastructure merge purpose
| Field Summary |
| Constructor Summary |
| Method Summary |
| public void | addPropertyChangeListener(PropertyChangeListener listener)
Adds a property change listener instance to the subscriber list |
| public void | addVetoableChangeListener(VetoableChangeListener listener)
When a third component change the catlet name, this one or a third party can veto the change |
| public boolean | askStop()
Returns true if the catlet allows the WebTop to stop/cleanup it. |
| public void | cleanup()
Called before the CATlet destruction. |
| public void | displayStatusBarMessage(String label)
Displays a label in the CATlet status bar This method is only implmented for the JCATlet implementation |
| public void | doActivate()
Activates the CATlet. |
| public void | doCleanup()
Called by the WebTop to clean the CATlet. |
| public void | doDeactivate()
Deactivates the CATlet. |
| public String | getCATletName()
Returns the name of the CATlet |
| public String | getClientID()
Returns the client id with which the catlet is connected to the server This method is already implemented by CATlet and JCATlet and developpers shouldn't mind about it |
| public CommandSelector | getCommandSelector()
Returns the command selector used to handle the CATlet commands life cycle. |
| public CSO | getCSO()
Returns the CSO object that contains this CATlet selection |
| public String | getCurrentDocumentName()
Returns the display name of the current Document loaded by the CATlet. |
| public Model | getModel()
Returns the CATlet main model This method is only implmented for the JCATlet implementation |
| public String | getServerHost()
Returns the server host on which this CATlet is binded This method is already implemented by CATlet and JCATlet and developpers shouldn't mind about it |
| public Integer | getVersion()
Returns the CATlet version |
| public ViewInterface | getView()
Returns the CATlet main view This method is only implmented for the JCATlet implementation |
| public String | getWorkshopFilename()
returns the file name that will be used for the workshop description of this catlet |
| public void | hideStatusBarMessage(String label)
Hides a label from the CATlet status bar This method is only implmented for the JCATlet implementation |
| public boolean | isActivated()
Returns the activation state of the CATlet. |
| public void | removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener instance from the subscriber list |
| public void | removeVetoableChangeListener(VetoableChangeListener listener)
When a third component change the catlet name, this one or a third party can veto the change |
| public void | setCATletName(String name)
Sets the CATlet name. |
| public void | setCurrentDocumentName(String name)
Sets the name of the current document of the CATlet. |
| public void | setDisplayedWorkbench(String workbenchID)
Sets the current displayed workbench according to its ID |
| public void | setWorkshopFilename(String name)
Sets the file name that will be used for the workshop description of this catlet |
| public void | start()
Starts the CATlet. |
| public void | stop()
Stops the CATlet. |
| Field Detail |
| Constructor Detail |
| Method Detail |
public void addPropertyChangeListener(PropertyChangeListener listener)
Adds a property change listener instance to the subscriber list
listener
public void addVetoableChangeListener(VetoableChangeListener listener)
When a third component change the catlet name, this one or a third party can veto the change
public boolean askStop()
Returns true if the catlet allows the WebTop to stop/cleanup it.
public void cleanup()
Called before the CATlet destruction. Used to stop threads or things that requiere
a special cleanup to be garbage collected.
public void displayStatusBarMessage(String label)
Displays a label in the CATlet status bar
This method is only implmented for the JCATlet implementation
public void doActivate()
Activates the CATlet.
In the defaults implementation of ICATlet (CATlet and JCATlet), this method is final
in order to do default activation calls, but it call the method activate() which
need to be overwritten by developers.
public void doCleanup()
Called by the WebTop to clean the CATlet. Implemented final. Application must overload
the cleanup method if they have objects to clean. doCleanup calls cleanup.
public void doDeactivate()
Deactivates the CATlet.
In the defaults implementation of ICATlet (CATlet and JCATlet), this method is final
in order to do default deactivation calls, but it call the method deactivate() which
need to be overwritten by developers.
public String getCATletName()
Returns the name of the CATlet
public String getClientID()
Returns the client id with which the catlet is connected to the server
This method is already implemented by CATlet and JCATlet and developpers shouldn't mind about it
public CommandSelector getCommandSelector()
Returns the command selector used to handle the CATlet commands life cycle.
public CSO getCSO()
Returns the CSO object that contains this CATlet selection
public String getCurrentDocumentName()
Returns the display name of the current Document loaded by the CATlet.
public Model getModel()
Returns the CATlet main model
This method is only implmented for the JCATlet implementation
public String getServerHost()
Returns the server host on which this CATlet is binded
This method is already implemented by CATlet and JCATlet and developpers shouldn't mind about it
public Integer getVersion()
Returns the CATlet version
public ViewInterface getView()
Returns the CATlet main view
This method is only implmented for the JCATlet implementation
public String getWorkshopFilename()
returns the file name that will be used for the workshop description of this catlet
public void hideStatusBarMessage(String label)
Hides a label from the CATlet status bar
This method is only implmented for the JCATlet implementation
public boolean isActivated()
Returns the activation state of the CATlet.
public void removePropertyChangeListener(PropertyChangeListener listener)
Removes a property change listener instance from the subscriber list
listener
public void removeVetoableChangeListener(VetoableChangeListener listener)
When a third component change the catlet name, this one or a third party can veto the change
public void setCATletName(String name)
Sets the CATlet name. This method may throw a PropertyVetoException as a
CATlet name must be unique inside a session so the WebTop can veto the new name
name
public void setCurrentDocumentName(String name)
Sets the name of the current document of the CATlet.
this name is displayed by the webtop in the taskbar.
display
public void setDisplayedWorkbench(String workbenchID)
Sets the current displayed workbench according to its ID
public void setWorkshopFilename(String name)
Sets the file name that will be used for the workshop description of this catlet
the
public void start()
Starts the CATlet. This method is not used for JCATlets : implementation is empty
public void stop()
Stops the CATlet. This method is not used for JCATlets : implementation is empty