Class FormatStep
- java.lang.Object
-
- org.pentaho.ui.xul.XulEventSourceAdapter
-
- org.pentaho.reporting.engine.classic.wizard.ui.xul.components.AbstractWizardStep
-
- org.pentaho.reporting.engine.classic.wizard.ui.xul.steps.FormatStep
-
- All Implemented Interfaces:
WizardStep
,org.pentaho.ui.xul.XulEventSource
public class FormatStep extends AbstractWizardStep
Todo: Document Me- Author:
- William Seyler
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected class
FormatStep.FormatStepHandler
-
Field Summary
-
Fields inherited from class org.pentaho.reporting.engine.classic.wizard.ui.xul.components.AbstractWizardStep
FINISHABLE_PROPERTY_NAME, messages, PREVIEWABLE_PROPERTY_NAME, SPACER_IMAGE_SRC, STEP_CONTAINER, STEP_IMAGE_SRC, VALID_PROPERTY_NAME, XUL_HBOX_TYPE, XUL_IMAGE_TYPE, XUL_LABEL_TYPE
-
-
Constructor Summary
Constructors Constructor Description FormatStep()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
createPresentationComponent(org.pentaho.ui.xul.XulDomContainer mainWizardContainer)
protected FieldWrapper
getActiveField()
protected Object
getActiveXulWrapper()
List<org.pentaho.reporting.engine.classic.wizard.ui.xul.steps.FormatStep.MetaDataWrapper>
getAllExpressionMetaDatas()
List<FieldWrapper>
getDetailFields()
List<FieldWrapper>
getGroupFields()
String
getStepName()
void
setBindings()
setBindings()void
setDetailFields(List<FieldWrapper> detailFields)
void
setGroupFields(List<FieldWrapper> groupFields)
void
stepActivating()
stepActivating()boolean
stepDeactivating()
Called on a step just before it becomes deactivated (before the new active step is shown).protected void
updateBindings(org.pentaho.ui.xul.containers.XulListbox activeTree)
-
Methods inherited from class org.pentaho.reporting.engine.classic.wizard.ui.xul.components.AbstractWizardStep
getAttributeContext, getBindingFactory, getDesignTimeContext, getDocument, getEditorModel, isFinishable, isPreviewable, isValid, setBindingFactory, setDesignTimeContext, setDocument, setEditorModel, setFinishable, setPreviewable, setValid
-
-
-
-
Method Detail
-
getActiveField
protected FieldWrapper getActiveField()
-
getActiveXulWrapper
protected Object getActiveXulWrapper()
-
setBindings
public void setBindings()
Description copied from interface:WizardStep
setBindings() Allows concrete implementations to set their bindings for enclosed properties and Xul defined elements.
-
stepActivating
public void stepActivating()
Description copied from interface:WizardStep
stepActivating() Called on each step just before it become active (before it's card is shown).- Specified by:
stepActivating
in interfaceWizardStep
- Overrides:
stepActivating
in classAbstractWizardStep
-
stepDeactivating
public boolean stepDeactivating()
Description copied from interface:WizardStep
Called on a step just before it becomes deactivated (before the new active step is shown).- Specified by:
stepDeactivating
in interfaceWizardStep
- Overrides:
stepDeactivating
in classAbstractWizardStep
- Returns:
- boolean indicating that this step should be allowed to become deactive
-
getGroupFields
public List<FieldWrapper> getGroupFields()
-
setGroupFields
public void setGroupFields(List<FieldWrapper> groupFields)
-
getDetailFields
public List<FieldWrapper> getDetailFields()
-
setDetailFields
public void setDetailFields(List<FieldWrapper> detailFields)
-
createPresentationComponent
public void createPresentationComponent(org.pentaho.ui.xul.XulDomContainer mainWizardContainer) throws org.pentaho.ui.xul.XulException
- Specified by:
createPresentationComponent
in interfaceWizardStep
- Overrides:
createPresentationComponent
in classAbstractWizardStep
- Throws:
org.pentaho.ui.xul.XulException
- Creates the presentation layer associated with this WizardStep. This is usually done by loading an overlay into the main_wzard_panel.xul
-
getStepName
public String getStepName()
- Returns:
- a string (must be localized) that describes this step
-
updateBindings
protected void updateBindings(org.pentaho.ui.xul.containers.XulListbox activeTree)
- Parameters:
activeTree
- Updates the bindings based on which list contains the currently selected item (either Detail or Group) The selected items fields are bound to their associated gui editor.
-
getAllExpressionMetaDatas
public List<org.pentaho.reporting.engine.classic.wizard.ui.xul.steps.FormatStep.MetaDataWrapper> getAllExpressionMetaDatas()
- Returns:
- a list of MetaDataWrappers
-
-