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

Framework : JApplicationFrame

Module : GW0Kernel

Class Description

public abstract class JCATletAbstract

Abstract Swing implementation of the ICATlet interface.

   All Implemented Interfaces:
ICATlet
CursorListener
SettingChangeListener
See Also:
com.dassault_systemes.catweb.base.catlet.ICATlet
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

VERSION_2

    Integer VERSION_2


views

    ViewInterface[] views
The views of MVC


isActivated

    boolean isActivated
for activation state


firstActivation

    boolean firstActivation


viewersWorkshop

    Vector viewersWorkshop


displayWorkshops

    boolean displayWorkshops


Constructor Detail

JCATletAbstract

    JCATletAbstract()

Default constructor. The workarea is contained inside a scrollpane


JCATletAbstract

    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.

Parameters:
workareaInScrollpane
- specified if the workarea is in a scrollpane or not

Method Detail

getCSO

    CSO getCSO()

Returns the CSO that handle selection for this CATlet. The CSO object is only instanciated on first demand


doCleanup

    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.

See Also:
com.dassault_systemes.catweb.base.catlet.ICATlet#cleanup()

finalize

    void finalize()


addNotify

    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


getView

    ViewInterface getView()

Returns the CATlet main view

See Also:
com.dassault_systemes.catweb.base.catlet.view.ViewInterface

setWorkshopFilename

    void setWorkshopFilename(String name)

Sets the file name that will be used for the workshop description of this catlet

Parameters:
the
file name of the CATlet workshop

getWorkshopFilename

    String getWorkshopFilename()

returns the file name that will be used for the workshop description of this catlet

Returns:
the file name of the CATlet workshop

isActivated

    boolean isActivated()

returns the activation state of the CATlet

Returns:
true if activated, false otherwise

activate

    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

See Also:
com.dassault_systemes.catweb.base.catlet.JCATlet#doActivate()

deactivate

    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

See Also:
com.dassault_systemes.catweb.base.catlet.JCATlet#doDeactivate()

getVersion

    Integer getVersion()


doActivate

    void doActivate()

method called by the Frame to activate the catlet. Implemented final. If activation is needed, the method activate() is called

See Also:
com.dassault_systemes.catweb.base.catlet.JCATlet#activate()

doDeactivate

    void doDeactivate()

method called by the Frame to deactivate the catlet. Implemented final. If deactivation is needed, the method deactivate() is called

See Also:
com.dassault_systemes.catweb.base.catlet.JCATlet#deactivate()

displayWorkshops

    void displayWorkshops()

Display the workshops of the catlet and its viewers in the toolbars and menubar


setVisible

    void setVisible(boolean isVisible)


isFocusTraversable

    boolean isFocusTraversable()


getCommandSelector

    CommandSelector getCommandSelector()

Returns the CommandSelector object that handle the life cycle of this CATlet attached Commands

See Also:
com.dassault_systemes.catweb.base.catlet.CommandSelector
com.dassault_systemes.catweb.base.catlet.command.Command

setCATletName

    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

Parameters:
name
- the new name of the CATlet
See Also:
java.beans.VetoableChangeListener
java.beans.PropertyChangeListener

getCATletName

    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

Returns:
the name of the CATlet

getCurrentDocumentName

    String getCurrentDocumentName()

Returns the name of the current Document of the CATlet

Returns:
the name of the current document

setCurrentDocumentName

    void setCurrentDocumentName(String name)

Sets the name of the current document of the CATlet. this name is displayed by the webtop in the taskbar

Parameters:
display
name of the current document

getName

    String getName()

Returns the CATlet name. this method call getCATletName method.

Returns:
the CATlet name
See Also:
com.dassault_systemes.catweb.base.catlet.JCATlet#getCATletName()

setName

    void setName(String name)

Calls setCATletName method and catch PropertyVetoException

Parameters:
new
name of the CATlet
See Also:
com.dassault_systemes.catweb.base.catlet.JCATlet#setCATletName(String name)

getHelpID

    int getHelpID()

Returns an Id that will be used to retreive the help for this CATlet By default, this methods returns -1


askStop

    boolean askStop()


start

    void start()


stop

    void stop()



Copyright © 2000, Dassault Systèmes. All rights reserved