|
|
||||
| Package com.dassault_systemes.catweb.base.catlet |
Class JCATletAbstract
|
| Class Hierarchy |
java.lang.Object
|
+-java.awt.Component
|
+-java.awt.Container
|
+-javax.swing.JComponent
|
+-javax.swing.JPanel
|
+-com.dassault_systemes.catweb.base.swing.CATJPanel
|
+-com.dassault_systemes.catweb.base.awt.ToolbarContainer
|
+-com.dassault_systemes.catweb.base.catlet.JCATletAbstract
| Class Location |
| Class Description |
public abstract class JCATletAbstract
Abstract Swing implementation of the ICATlet interface.
All Implemented Interfaces: ICATlet CursorListener SettingChangeListener
| Field Summary |
| Integer | VERSION_2 |
| ViewInterface[] | views |
| boolean | isActivated |
| boolean | firstActivation |
| Vector | viewersWorkshop |
| boolean | displayWorkshops |
| Constructor Summary |
| JCATletAbstract() |
| JCATletAbstract(boolean workareaInScrollpane) |
| Method Summary |
| CSO | getCSO() |
| void | doCleanup() |
| void | finalize() |
| void | addNotify() |
| ViewInterface | getView() |
| void | setWorkshopFilename(String name) |
| String | getWorkshopFilename() |
| boolean | isActivated() |
| void | activate() |
| void | deactivate() |
| Integer | getVersion() |
| void | doActivate() |
| void | doDeactivate() |
| void | displayWorkshops() |
| void | setVisible(boolean isVisible) |
| boolean | isFocusTraversable() |
| CommandSelector | getCommandSelector() |
| void | setCATletName(String name) |
| String | getCATletName() |
| String | getCurrentDocumentName() |
| void | setCurrentDocumentName(String name) |
| String | getName() |
| void | setName(String name) |
| int | getHelpID() |
| boolean | askStop() |
| void | start() |
| void | stop() |
| Field Detail |
Integer VERSION_2
ViewInterface[] views
The views of MVC
boolean isActivated
for activation state
boolean firstActivation
Vector viewersWorkshop
boolean displayWorkshops
| Constructor Detail |
JCATletAbstract()
Default constructor. The workarea is contained inside a scrollpane
JCATletAbstract(boolean workareaInScrollpane)
Constructor. Flag let you choose in what is contained the workarea. If set to true
workarea is contained inside a JScrollpane. If set to false, workarea is contained
inside a JPanel.
workareaInScrollpane| Method Detail |
CSO getCSO()
Returns the CSO that handle selection for this CATlet.
The CSO object is only instanciated on first demand
void doCleanup()
Called by the WebTop to clean the CATlet. Implemented final.
Application must overload the cleanup() method if they have objects to clean.
this method calls cleanup() method.
void finalize()
void addNotify()
If a CATlet is added inside a container and is not activated yet, do it
This let the CATlet autoactivate itself in a desktop-less environment
ViewInterface getView()
Returns the CATlet main view
void setWorkshopFilename(String name)
Sets the file name that will be used for the workshop description of this catlet
the
String getWorkshopFilename()
returns the file name that will be used for the workshop description of this catlet
boolean isActivated()
returns the activation state of the CATlet
void activate()
Called when the catlet is activated.
This method is not directly called by the Frame but by the doActivate() method
Users should put functionnalities related to activation in this method
void deactivate()
Called when the catlet is deactivated
This method is not directly called by the Frame but by the doDeactivate() method
Users should put functionnalities related to deactivation in this method
Integer getVersion()
void doActivate()
method called by the Frame to activate the catlet. Implemented final.
If activation is needed, the method activate() is called
void doDeactivate()
method called by the Frame to deactivate the catlet. Implemented final.
If deactivation is needed, the method deactivate() is called
void displayWorkshops()
Display the workshops of the catlet and its viewers in the toolbars and menubar
void setVisible(boolean isVisible)
boolean isFocusTraversable()
CommandSelector getCommandSelector()
Returns the CommandSelector object that handle the life cycle of
this CATlet attached Commands
void setCATletName(String name)
Set the name of this catlet.
The CATlet name is a vetoable property. Each time the catlet name is modified,
a propertyChangeEvent is fired. If you want to veto this property, you must
subscribe on addVetoableListener otherwise, if you just want to be warned,
subscribe on addPropertyChangeListener
name
String getCATletName()
Returns the CATlet name. If no name has been provided, then the display name of the
BeanDescriptor will be returned. If no BeanDescriptor is provided, the name "CATlet"
is returned instead
String getCurrentDocumentName()
Returns the name of the current Document of the CATlet
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
String getName()
Returns the CATlet name.
this method call getCATletName method.
void setName(String name)
Calls setCATletName method and catch PropertyVetoException
new
int getHelpID()
Returns an Id that will be used to retreive the help for this CATlet
By default, this methods returns -1
boolean askStop()
void start()
void stop()