org.telscenter.pas.beans
Class PasStep

java.lang.Object
  java.beans.beancontext.BeanContextChildSupport
      org.telscenter.pas.beans.PasStep

All Implemented Interfaces:

java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextChildComponentProxy, java.beans.beancontext.BeanContextServiceRevokedListener, java.beans.beancontext.BeanContextServicesListener, java.io.Serializable, java.util.EventListener, net.sf.sail.common.beansupport.ITitleAware, IAuthorNotation, IHelp

Direct Known Subclasses:

AbstractUrlStep, AppletViewer, Assessment, ExecStep, Generic, HelloWorld, HingedDelegator, HingeSelector, ImageCollector, JaxbQtiStep, JgroupsDraw, JgroupsWhiteboard, JmdnsBrowsingStep, MulticastListener, Pedraw, ProjectInfoStep, Sensemaker, ShowAllWorkStep, UnsupportedConversion

public abstract class PasStep
extends java.beans.beancontext.BeanContextChildSupport
implements java.beans.beancontext.BeanContextChildComponentProxy, IAuthorNotation, net.sf.sail.common.beansupport.ITitleAware, IHelp

Abstract superclass of all beans representing Pas steps.

Version:

$Id: PasStep.java 1817 2007-04-09 21:33:53 +0000 (Mon, 09 Apr 2007) aperritano $

Author:

turadg, Laurel Williams

See Also:

Serialized Form

Field Summary

Fields inherited from class java.beans.beancontext.BeanContextChildSupport

beanContext, beanContextChildPeer, pcSupport, rejectedSetBCOnce, vcSupport

Constructor Summary

PasStep()
Default constructor for Bean pattern

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
void	afterComponentAdded() This gets called when the Component returned by getComponent() is added into a Container.
protected void	beforeSessionStart() PasProject calls this method on each step after assembly() and before showing its frame.
protected void	consumeService(java.beans.beancontext.BeanContextServices bcs, java.lang.Class<? extends java.lang.Object> serviceClass)
java.lang.String	getAuthorNotes()
java.lang.String	getHelpId()
HintSet	getHintSet()
java.lang.String	getHoverString()
java.lang.String	getTitle()
java.lang.String	getType() Replaced by hoverString property
boolean	hasHints()
protected void	initializeBeanContextResources()
protected void	initializePasStep(java.beans.beancontext.BeanContextServices bcs) Called by initializeBeanContextResources() during the unmarshalling phase, before the assembly phase.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	serviceAvailable(java.beans.beancontext.BeanContextServiceAvailableEvent bcsae)
void	setAuthorNotes(java.lang.String authorNotes)
void	setBeanContext(java.beans.beancontext.BeanContext bc)
void	setHintSet(HintSet hintSet)
void	setHoverString(java.lang.String hoverString)
void	setTitle(java.lang.String title)
void	stepEnter()
void	stepExit()
java.lang.String	toString()

Methods inherited from class java.beans.beancontext.BeanContextChildSupport

addPropertyChangeListener, addVetoableChangeListener, firePropertyChange, fireVetoableChange, getBeanContext, getBeanContextChildPeer, isDelegated, releaseBeanContextResources, removePropertyChangeListener, removeVetoableChangeListener, serviceRevoked, validatePendingSetBeanContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.beans.beancontext.BeanContextChildComponentProxy

getComponent

Constructor Detail

PasStep

public PasStep()

Default constructor for Bean pattern

Method Detail

hasHints

public boolean hasHints()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

afterComponentAdded

public void afterComponentAdded()

This gets called when the Component returned by getComponent() is added into a Container.

See Also:

beforeSessionStart

beforeSessionStart

protected void beforeSessionStart()

PasProject calls this method on each step after assembly() and before showing its frame. If the step has any heavy lifting to do, do it now so when the user reaches the step it comes up quickly.

NOTE:: this will no be called in authoring, or any environments other than a learning session. It is only a hint and cannot be relied upon.

consumeService

protected void consumeService(java.beans.beancontext.BeanContextServices bcs,
                              java.lang.Class<? extends java.lang.Object> serviceClass)

stepEnter

public void stepEnter()

stepExit

public void stepExit()

getAuthorNotes

public java.lang.String getAuthorNotes()

Specified by:

getAuthorNotes in interface IAuthorNotation

getHintSet

public HintSet getHintSet()

getTitle

public java.lang.String getTitle()

Specified by:

getTitle in interface net.sf.sail.common.beansupport.ITitleAware

Specified by:

getTitle in interface IAuthorNotation

initializeBeanContextResources

protected void initializeBeanContextResources()

Overrides:

initializeBeanContextResources in class java.beans.beancontext.BeanContextChildSupport

initializePasStep

protected void initializePasStep(java.beans.beancontext.BeanContextServices bcs)

Called by initializeBeanContextResources() during the unmarshalling phase, before the assembly phase. Thus, at this point the object can't make use of anything outside its own context Pod.

By default, does nothing. Override in child.

Parameters:

bcs -

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

serviceAvailable

public void serviceAvailable(java.beans.beancontext.BeanContextServiceAvailableEvent bcsae)

Specified by:

serviceAvailable in interface java.beans.beancontext.BeanContextServicesListener

Overrides:

serviceAvailable in class java.beans.beancontext.BeanContextChildSupport

setAuthorNotes

public void setAuthorNotes(java.lang.String authorNotes)

Specified by:

setAuthorNotes in interface IAuthorNotation

getType

public java.lang.String getType()

Replaced by hoverString property

Returns:

getHelpId

public java.lang.String getHelpId()

Specified by:

getHelpId in interface IHelp

Returns:

The string help id of for this bean/class.
This help id should correspond to a "target" string found in a map.jhm file. See the JavaHelp User's guide for more information about map.jhm.

See Also:

IHelp.getHelpId()

setBeanContext

public void setBeanContext(java.beans.beancontext.BeanContext bc)
                    throws java.beans.PropertyVetoException

Specified by:

setBeanContext in interface java.beans.beancontext.BeanContextChild

Overrides:

setBeanContext in class java.beans.beancontext.BeanContextChildSupport

Throws:

java.beans.PropertyVetoException

See Also:

BeanContextChildSupport.setBeanContext(java.beans.beancontext.BeanContext)

setHintSet

public void setHintSet(HintSet hintSet)

setTitle

public void setTitle(java.lang.String title)

Specified by:

setTitle in interface net.sf.sail.common.beansupport.ITitleAware

Specified by:

setTitle in interface IAuthorNotation

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getHoverString

public java.lang.String getHoverString()

Returns:

the hoverString

setHoverString

public void setHoverString(java.lang.String hoverString)

Parameters:

hoverString - the hoverString to set