Package com.dassault_systemes.catweb.base.catlet

   
Class CATlet

 
Class Hierarchy
java.lang.Object
  |
  +-java.awt.Component
        |
        +-java.awt.Container
              |
              +-com.dassault_systemes.catweb.base.awt.AWTToolbarContainer
                    |
                    +-com.dassault_systemes.catweb.base.catlet.CATlet
Class Location

Framework : PortalBase

Module : PLBbase

Class Description

public abstract class CATlet

AWT implementation of the ICATlet interface.

   All Implemented Interfaces:
ICATlet
LogonListener
CursorListener
ServerConnectionListener
See Also:
com.dassault_systemes.catweb.base.catlet.ICATlet
Field Summary
Integer VERSION_2
ViewInterface[] views
Model[] models
boolean isActivated
boolean firstActivation

Constructor Summary
CATlet()
CATlet(boolean workareaInScrollpane)

Method Summary
boolean askStop()
CSO getCSO()
void doCleanup()
void finalize()
void addNotify()
void update(Graphics g)
Dimension getPreferredSize()
boolean isActivated()
void doActivate()
void doDeactivate()
void activate()
void deactivate()
Integer getVersion()
void setCATletName(String name)
String getCATletName()
String getCurrentDocumentName()
void setCurrentDocumentName(String name)
String getName()
void setName(String name)
void setVisible(boolean isVisible)
boolean isFocusTraversable()
void displayWorkshops()
void fireVetoableChange(String propertyName, Object oldValue, Object newValue)
void addVetoableChangeListener(VetoableChangeListener listener)
void removeVetoableChangeListener(VetoableChangeListener listener)
void firePropertyChange(String propertyName, Object oldValue, Object newValue)
void addPropertyChangeListener(PropertyChangeListener listener)
void removePropertyChangeListener(PropertyChangeListener listener)
Model getModel()
ViewInterface getView()
void displayStatusBarMessage(String label)
void hideStatusBarMessage(String label)
void setWorkshopFilename(String name)
String getWorkshopFilename()


Field Detail

VERSION_2

    Integer VERSION_2


views

    ViewInterface[] views
The views of MVC


models

    Model[] models
The models of MVC


isActivated

    boolean isActivated
for activation state


firstActivation

    boolean firstActivation


Constructor Detail

CATlet

    CATlet()

Default constructor - The workarea has no scroll


CATlet

    CATlet(boolean workareaInScrollpane)

Constructor with flag for workarea scroll

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

Method Detail

askStop

    boolean askStop()

Returns true if the catlet allows the ApplicationController to stop/cleanup it.


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 lets the CATlet autoactivate itself in a desktop-less environment


update

    void update(Graphics g)


getPreferredSize

    Dimension getPreferredSize()


isActivated

    boolean isActivated()

returns the activation state of the CATlet

Returns:
true if activated, false otherwise

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.CATlet#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.CATlet#deactivate()

activate

    void activate()

Called when the catlet is activated. This method is not directly called by the Frame but by the doActivate() method

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

deactivate

    void deactivate()

Called when the catlet is deactivated This method is not directly called by the Frame but by the doDeactivate() method

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

getVersion

    Integer getVersion()


setCATletName

    void setCATletName(String name)

Sets 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 display name of the current Document loaded by 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()

this method call getCATletName method.

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

setName

    void setName(String name)

this method calls setCATletName method and catches PropertyVetoException

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

setVisible

    void setVisible(boolean isVisible)


isFocusTraversable

    boolean isFocusTraversable()


displayWorkshops

    void displayWorkshops()

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


fireVetoableChange

    void fireVetoableChange(String propertyName, Object oldValue, Object newValue)


addVetoableChangeListener

    void addVetoableChangeListener(VetoableChangeListener listener)


removeVetoableChangeListener

    void removeVetoableChangeListener(VetoableChangeListener listener)


firePropertyChange

    void firePropertyChange(String propertyName, Object oldValue, Object newValue)


addPropertyChangeListener

    void addPropertyChangeListener(PropertyChangeListener listener)

Adds the specified listener to receive property change events from this model.


removePropertyChangeListener

    void removePropertyChangeListener(PropertyChangeListener listener)

Removes the specified listener so that it no longer receives property change events from this model.


getModel

    Model getModel()

Not implemented - Should return the main model of the MVC

See Also:
com.dassault_systemes.catweb.base.catlet.model.Model

getView

    ViewInterface getView()

Not implemented - Should return the main view of the MVC

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

displayStatusBarMessage

    void displayStatusBarMessage(String label)

Not implemented


hideStatusBarMessage

    void hideStatusBarMessage(String label)

Not implemented


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


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