/*
    * Created on Apr 27, 2005, Copyright UC Regents
    */
   package org.telscenter.pas.beans;
   
   import java.beans.PropertyChangeListener;
   import java.beans.PropertyVetoException;
   import java.beans.beancontext.BeanContext;
   import java.beans.beancontext.BeanContextChildComponentProxy;
  import java.beans.beancontext.BeanContextChildSupport;
  import java.beans.beancontext.BeanContextServiceAvailableEvent;
  import java.beans.beancontext.BeanContextServices;
  import java.util.ArrayList;
  import java.util.List;
  
  import net.sf.sail.common.beansupport.ITitleAware;
  import net.sf.sail.core.util.SailBeanUtils;
  
  import org.telscenter.pas.hint.Hint;
  import org.telscenter.pas.properties.HintSet;
  
  /***
   * Abstract superclass of all beans representing Pas steps.
   * 
   * @author turadg
   * @author Laurel Williams
   * 
   * @version $Id: PasStep.java 1817 2007-04-09 21:33:53 +0000 (Mon, 09 Apr 2007)
   *          aperritano $
   */
  public abstract class PasStep extends BeanContextChildSupport implements
  		BeanContextChildComponentProxy, IAuthorNotation, ITitleAware, IHelp {
  
  	private static final String HELP_ID = "step";
  
  	static int instanceCount;
  
  	// nth step in VM for identification in toString()
  	int instanceNumber = instanceCount++;
  
  	String authorNotes = ""; //$NON-NLS-1$
  
  	boolean bcSet = false;
  
  	private HintSet hintSet = new HintSet();
  
  	String title = "UNDEFINED"; //$NON-NLS-1$
  
  	String hoverString = "Pas Step";
  	
  	/***
  	 * Default constructor for Bean pattern
  	 */
  	public PasStep() {
  		// nothing
  	}
  
  	// helper
  	public boolean hasHints() {
  		if (hintSet == null) {
  			return false;
  		} else if (hintSet.isEmpty()) {
  			return false;
  		}// if
  		return true;
  	}
  
  	// added so the bean editor can detect which properties are bound
  	public void addPropertyChangeListener(PropertyChangeListener listener) {
  		pcSupport.addPropertyChangeListener(listener);
  	}
  
  	/***
  	 * <p>
  	 * This gets called when the Component returned by getComponent() is added
  	 * into a Container.
  	 * </p>
  	 * 
  	 * @see beforeSessionStart
  	 */
  	public void afterComponentAdded() {
  		// by default, do nothing
  	}
  
  	/***
  	 * <p>
  	 * 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.
  	 * </p>
  	 * <p>
  	 * <b>NOTE:</b>: 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.
  	 * </p>
  	 */
  	protected void beforeSessionStart() {
  		// by default, do nothing
  	}
 
 	protected void consumeService(BeanContextServices bcs, Class<? extends Object> serviceClass) {
 		// by default do nothing
 	}
 
 	// Navigation method - called by PasProject
 	public void stepEnter() {
 		// by default do nothing
 	}
 
 	// Navigation method - called by PasProject
 	public void stepExit() {
 		// by default do nothing
 	}
 
 	public String getAuthorNotes() {
 		return authorNotes;
 	}
 
 	public HintSet getHintSet() {
 		return hintSet;
 	}
 
 	public String getTitle() {
 		return title;
 	}
 
 	protected void initializeBeanContextResources() {
 		if (!bcSet) {
 			throw new IllegalStateException(
 					"initializeBeanContextResources() called before setBeanContext()"); //$NON-NLS-1$
 		}
 		super.initializeBeanContextResources();
 
 		BeanContextServices bcs = SailBeanUtils.findServicesContextOf(this);
 		bcs.addBeanContextServicesListener(this); // for consumeService
 		initializePasStep(bcs);
 	}
 
 	/***
 	 * <p>
 	 * 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.
 	 * </p>
 	 * <p>
 	 * By default, does nothing. Override in child.
 	 * </p>
 	 * 
 	 * @param bcs
 	 */
 	protected void initializePasStep(BeanContextServices bcs) {
 		// do nothing, override in child
 	}
 
 	// added so the bean editor can detect which properties are bound
 	public void removePropertyChangeListener(PropertyChangeListener listener) {
 		pcSupport.removePropertyChangeListener(listener);
 	}
 
 	public void serviceAvailable(BeanContextServiceAvailableEvent bcsae) {
 		BeanContextServices bcs = SailBeanUtils.findServicesContextOf(this);
 		Class<?> serviceClass = bcsae.getServiceClass();
 
 		consumeService(bcs, serviceClass);
 	}
 
 	public void setAuthorNotes(String authorNotes) {
 		Object old = this.authorNotes;
 		this.authorNotes = authorNotes;
 		firePropertyChange("authorNotes", old, authorNotes); //$NON-NLS-1$
 	}
 
 	/***
 	 * Replaced by <tt>hoverString</tt> property
 	 * @deprecate
 	 * @return
 	 */
 	public String getType() {
 		return hoverString;
 	}
 
 	/***
 	 * @see org.telscenter.pas.beans.IHelp#getHelpId()
 	 */
 	public String getHelpId() {
 		return HELP_ID;
 	}
 
 	/***
 	 * @see java.beans.beancontext.BeanContextChildSupport#setBeanContext(java.beans.beancontext.BeanContext)
 	 */
 	public synchronized void setBeanContext(BeanContext bc)
 			throws PropertyVetoException {
 		if (bc == null) {
 			throw new NullPointerException("null BeanContext"); //$NON-NLS-1$
 		}
 		bcSet = true;
 		super.setBeanContext(bc);
 	}
 
 	public void setHintSet(HintSet hintSet) {
 		HintSet old = this.hintSet;
 		this.hintSet = hintSet;
 		firePropertyChange("hintSet", old, hintSet); //$NON-NLS-1$
 	}
 
 	public void setTitle(String title) {
 		Object old = this.title;
 		this.title = title;
 		firePropertyChange("title", old, title);//$NON-NLS-1$
 	}
 
 	public final String toString() {
 		return getClass().getSimpleName()
 				+ "(stepInstance#" + instanceNumber + ") " + getTitle(); //$NON-NLS-1$
 	}
 
 	/***
 	 * @return the hoverString
 	 */
 	public String getHoverString() {
 		return hoverString;
 	}
 
 	/***
 	 * @param hoverString the hoverString to set
 	 */
 	public void setHoverString(String hoverString) {
 		this.hoverString = hoverString;
 	}
 
 }