Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.pentaho.platform.dataaccess.datasource.wizard.steps
Class AbstractWizardStep<T extends IWizardModel>

java.lang.Object
  extended by XulEventSourceAdapter
      extended by org.pentaho.platform.dataaccess.datasource.wizard.steps.AbstractWizardStep<T>
All Implemented Interfaces:
IWizardStep
Direct Known Subclasses:
PhysicalStep, StageDataStep, VisualizeStep
public abstract class AbstractWizardStep<T extends IWizardModel>
extends XulEventSourceAdapter
implements IWizardStep

Todo: Document Me

Author:
William Seyler

Field Summary
static String DISABLED_PROPERTY_NAME
           
static String FINISHABLE_PROPERTY_NAME
           
static String PREVIEWABLE_PROPERTY_NAME
           
static String SPACER_IMAGE_SRC
           
static String STEP_GRID_ID
           
static String STEP_IMAGE_SRC
           
static String STEP_ROWS_ID
           
static String VALID_PROPERTY_NAME
           
static String XUL_IMAGE_TYPE
           
static String XUL_LABEL_TYPE
           
static String XUL_ROW_TYPE
           
 
Method Summary
 void createPresentationComponent(XulDomContainer mainWizardContainer)
           
 BindingFactory getBindingFactory()
           
 Document getDocument()
           
 T getModel()
           
 boolean isDisabled()
          isDisabled()
 boolean isFinishable()
          
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.platform.dataaccess.datasource.wizard.steps.IWizardStep
getStepName, setBindings
 

Field Detail

VALID_PROPERTY_NAME

public static final String VALID_PROPERTY_NAME
See Also:
Constant Field Values

PREVIEWABLE_PROPERTY_NAME

public static final String PREVIEWABLE_PROPERTY_NAME
See Also:
Constant Field Values

FINISHABLE_PROPERTY_NAME

public static final String FINISHABLE_PROPERTY_NAME
See Also:
Constant Field Values

DISABLED_PROPERTY_NAME

public static final String DISABLED_PROPERTY_NAME
See Also:
Constant Field Values

STEP_GRID_ID

public static final String STEP_GRID_ID
See Also:
Constant Field Values

STEP_ROWS_ID

public static final String STEP_ROWS_ID
See Also:
Constant Field Values

XUL_ROW_TYPE

public static final String XUL_ROW_TYPE
See Also:
Constant Field Values

XUL_IMAGE_TYPE

public static final String XUL_IMAGE_TYPE
See Also:
Constant Field Values

XUL_LABEL_TYPE

public static final String XUL_LABEL_TYPE
See Also:
Constant Field Values

STEP_IMAGE_SRC

public static final String STEP_IMAGE_SRC
See Also:
Constant Field Values

SPACER_IMAGE_SRC

public static final String SPACER_IMAGE_SRC
See Also:
Constant Field Values
Method Detail

isValid

Checks, whether the step is currently valid. This returns false as soon as any of the properties changed.





Specified by:
isValid in interface IWizardStep







Returns:
true, if the model matches the step's internal state, false otherwise.









setFinishable


Description copied from interface: IWizardStep


setFinishable()





Specified by:
setFinishable in interface IWizardStep






Parameters:
finishable - sets the flag that determines if the "Finish" button should be enabled for this
 wizard panel.









isFinishable




Specified by:
isFinishable in interface IWizardStep







Returns:
a boolean that determines if the "Finish" button should be enabled.









setBindingFactory


public void setBindingFactory(BindingFactory bf)






Specified by:
setBindingFactory in interface IWizardStep
















getBindingFactory


public BindingFactory getBindingFactory()






















getDocument


public Document getDocument()






















setDocument


public void setDocument(Document document)






Specified by:
setDocument in interface IWizardStep
















createPresentationComponent


public void createPresentationComponent(XulDomContainer mainWizardContainer)
                                 throws XulException






Specified by:
createPresentationComponent in interface IWizardStep







Throws:

XulException










isDisabled


public boolean isDisabled()




Description copied from interface: IWizardStep


isDisabled()





Specified by:
isDisabled in interface IWizardStep







Returns:
boolean that indicates if this step is active in the current linear controller
 
 If this returns false the linear wizard controller will skip this step and move to the next
 enabled step.










setDisabled


public void setDisabled(boolean disabled)




Description copied from interface: IWizardStep


setDisabled(boolean disable);





Specified by:
setDisabled in interface IWizardStep
















stepActivatingForward


public void stepActivatingForward()




Description copied from interface: IWizardStep


stepActivatingForward()
 
 Called if the step that is activating is higher in the list than the current one (next).





Specified by:
stepActivatingForward in interface IWizardStep
















stepActivatingReverse


public void stepActivatingReverse()




Description copied from interface: IWizardStep


stepActivatingReverse()
 
 Called if the step that is activatig is lower in the list than the current active one (back)





Specified by:
stepActivatingReverse in interface IWizardStep
















stepDeactivatingForward


public boolean stepDeactivatingForward()




Description copied from interface: IWizardStep


Called on a step just before it becomes deactivated (before the next active step is shown)
 on response to moving forward in the step list (next).





Specified by:
stepDeactivatingForward in interface IWizardStep







Returns:
boolean indicating that this step should be allowed to become deactive










setStepImageVisible


public void setStepImageVisible(boolean visible)






















stepDeactivatingReverse


public boolean stepDeactivatingReverse()




Description copied from interface: IWizardStep


Called on a step just before it become deactivated (before the next active step is shown)
 on response to moving backward in the step list (back)





Specified by:
stepDeactivatingReverse in interface IWizardStep







Returns:
boolean indicating that this step should be allowed to become deactive










getModel


public T getModel()






















setModel


public void setModel(T model)

































  

      Overview 
      Package 
    Class 
      Use 
      Tree 
      Deprecated 
      Index 
      Help 
  













 PREV CLASS 
 NEXT CLASS

  FRAMES   
 NO FRAMES   
 









  SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD