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
protected boolean firstActivation
protected boolean isActivated
for activation state
protected Model[] models
The models of MVC
public static final Integer VERSION_2
protected ViewInterface[] views
The views of MVC

Constructor Summary
CATlet()
Default constructor - The workarea has no scroll
CATlet(boolean workareaInScrollpane)
Constructor with flag for workarea scroll

Method Summary
protected abstract void activate()
Called when the catlet is activated.
public 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
public synchronized void addPropertyChangeListener(PropertyChangeListener listener)
Adds the specified listener to receive property change events from this model.
public synchronized void addVetoableChangeListener(VetoableChangeListener listener)
public boolean askStop()
Returns true if the catlet allows the ApplicationController to stop/cleanup it.
protected abstract void deactivate()
Called when the catlet is deactivated This method is not directly called by the Frame but by the doDeactivate() method
public void displayStatusBarMessage(String label)
Not implemented
protected void displayWorkshops()
Displays the workshops of the catlet and its viewers in the toolbars and menubar
public final void doActivate()
method called by the Frame to activate the catlet.
public final void doCleanup()
Called by the WebTop to clean the CATlet.
public final void doDeactivate()
method called by the Frame to deactivate the catlet.
public void finalize()
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)
protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue)
public final String getCATletName()
Returns the CATlet name.
public CSO getCSO()
Returns the CSO that handle selection for this CATlet.
public String getCurrentDocumentName()
Returns the display name of the current Document loaded by the CATlet
public Model getModel()
Not implemented - Should return the main model of the MVC
public String getName()
this method call getCATletName method.
public Dimension getPreferredSize()
public final Integer getVersion()
public ViewInterface getView()
Not implemented - Should return the main view of the MVC
public String getWorkshopFilename()
Returns the file name that will be used for the workshop description of this catlet
public void hideStatusBarMessage(String label)
Not implemented
public boolean isActivated()
returns the activation state of the CATlet
public boolean isFocusTraversable()
public synchronized void removePropertyChangeListener(PropertyChangeListener listener)
Removes the specified listener so that it no longer receives property change events from this model.
public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)
public final void setCATletName(String name)
Sets the name of this catlet.
public void setCurrentDocumentName(String name)
Sets the name of the current document of the CATlet.
public void setName(String name)
this method calls setCATletName method and catches PropertyVetoException
public void setVisible(boolean isVisible)
public void setWorkshopFilename(String name)
Sets the file name that will be used for the workshop description of this catlet
public void update(Graphics g)


Field Detail

firstActivation

    protected boolean firstActivation


isActivated

    protected boolean isActivated
for activation state


models

    protected Model[] models
The models of MVC


VERSION_2

    public static final Integer VERSION_2


views

    protected ViewInterface[] views
The views of MVC


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

activate

    protected abstract 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()

addNotify

    public 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


addPropertyChangeListener

    public synchronized void addPropertyChangeListener(PropertyChangeListener listener)

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


addVetoableChangeListener

    public synchronized void addVetoableChangeListener(VetoableChangeListener listener)


askStop

    public boolean askStop()

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


deactivate

    protected abstract 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()

displayStatusBarMessage

    public void displayStatusBarMessage(String label)

Not implemented


displayWorkshops

    protected void displayWorkshops()

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


doActivate

    public final 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()

doCleanup

    public final 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()

doDeactivate

    public final 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()

finalize

    public void finalize()


firePropertyChange

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


fireVetoableChange

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


getCATletName

    public final 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

Return:
the name of the CATlet

getCSO

    public CSO getCSO()

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


getCurrentDocumentName

    public String getCurrentDocumentName()

Returns the display name of the current Document loaded by the CATlet

Return:
the name of the current document

getModel

    public Model getModel()

Not implemented - Should return the main model of the MVC

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

getName

    public String getName()

this method call getCATletName method.

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

getPreferredSize

    public Dimension getPreferredSize()


getVersion

    public final Integer getVersion()


getView

    public ViewInterface getView()

Not implemented - Should return the main view of the MVC

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

getWorkshopFilename

    public String getWorkshopFilename()

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

Return:
the file name of the CATlet workshop

hideStatusBarMessage

    public void hideStatusBarMessage(String label)

Not implemented


isActivated

    public boolean isActivated()

returns the activation state of the CATlet

Return:
true if activated, false otherwise

isFocusTraversable

    public boolean isFocusTraversable()


removePropertyChangeListener

    public synchronized void removePropertyChangeListener(PropertyChangeListener listener)

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


removeVetoableChangeListener

    public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)


setCATletName

    public final 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
Throws:
PropertyVetoException - If the new name is rejected
See Also:
java.beans.VetoableChangeListener
java.beans.PropertyChangeListener

setCurrentDocumentName

    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

Parameters:
display
name of the current document

setName

    public 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

    public void setVisible(boolean isVisible)


setWorkshopFilename

    public 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

update

    public void update(Graphics g)



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