| org.pentaho.jfreereport.wizard.ui.WizardPanel
All known Subclasses: org.pentaho.jfreereport.wizard.ui.step.PageSetupPanel, org.pentaho.jfreereport.wizard.ui.step.QueryPanel, org.pentaho.jfreereport.wizard.ui.step.MappingPanel, org.pentaho.jfreereport.wizard.ui.step.ReportSetupPanel, org.pentaho.jfreereport.wizard.ui.step.GroupAndDetailPanel, org.pentaho.jfreereport.wizard.ui.step.FieldSetupPanel, org.pentaho.jfreereport.wizard.ui.step.ReportDefinitionPanel,
| WizardPanel | | public class WizardPanel extends Composite implements SelectionListener,IWizardListener,KeyListener(Code) | | This class is the base class for all wizard panels. WizardPanels are added to a WizardManager's "step" list. A WizardPanel may override several methods to control wizard behavior, for example, isContinueAllowed() is used to determine if
enough information has been filled out by the user to continue to the next step (or finish).
|
| Constructor Summary | |
| public | WizardPanel(Composite parent, int style, WizardManager manager)
Creates a new WizardPanel object. |
| Method Summary | |
| public void | addDirtyListener(IDirtyListener l)
| | public void | backFired(WizardPanel source)
This method is called when the WizardManager is told to move to the previous step. | | public boolean | cancelFired(WizardPanel source)
This method is called when the WizardManager is informed that the wizard is cancelled. | | public Composite | createContentPanel(int hSpan)
This method creates the main panel composite used by Wizard Panels. | | public void | finishFired(WizardPanel source)
This method is called when the WizardManager is told to finish. | | public void | fireDirtyEvent()
| | public Composite | getMainPanel()
This method gets the main panel (Composite). | | public Properties | getProperties()
| | public WizardManager | getWizardManager()
| | public void | initWizardPanel()
| | public void | initialize(WizardManager manager)
| | public boolean | isBackAllowed()
This method should be overridden by subclasses to return if we are allowed to move back (the default behavior here is to return true, which is likely acceptable most of the time). | | public boolean | isContinueAllowed()
This method should be overridden by subclasses to return if we are allowed to move to the next step or finish. | | public boolean | isNextAllowed()
This method should be overridden by subclasses to return if we are allowed to move to the next step. | | public void | keyPressed(KeyEvent e)
This method is fired when a key is pressed on components we have added the WizardPanel as a KeyListener on. | | public void | keyReleased(KeyEvent e)
This method is fired when a key is released on components we have added the WizardPanel as a KeyListener on. | | public boolean | nextFired(WizardPanel source)
This method is called when the WizardManager is told to move to the next step. | | public boolean | previewFired(WizardPanel source)
This method is called when the WizardManager is informed that the wizard is previewing. | | public void | publishFired(WizardPanel source)
| | public void | removeAllDirtyListeners()
| | public void | removeDirtyListener(IDirtyListener l)
| | public void | setMainPanel(Composite mainPanel)
This method sets the main panel (Composite). | | public void | setWizardManager(WizardManager wizardManager)
| | public void | updateState()
This method updates the button enabled state as well as the overall panel enabled state. | | public void | widgetDefaultSelected(SelectionEvent e)
This method is necessary to implement when implementing SelectionListener and we do not use it. | | public void | widgetSelected(SelectionEvent e)
When any widget is selected, such as a button, a combobox, a checkbox, etc, we mark dirty/stateChanged unless the event originates from next/back/finish/cancel buttons. |
| dirty | | public boolean dirty(Code) | | There are two flags that mark a wizard step, dirty and stateChanged. Dirty is used to indicate that we are too dirty to continue, it should only be used for special cases.
|
| eventListenerList | | List eventListenerList(Code) | | This list contains IDirtyListeners who care about being notified when dirtiness happens.
|
| labelFont | | protected Font labelFont(Code) | | |
| mainPanel | | protected Composite mainPanel(Code) | | An SWT Composite which is the main content area for a wizard step.
|
| stateChanged | | public boolean stateChanged(Code) | | stateChanged is the primary flag to indicate that something has changed. The purpose of this flag is to allow us to process or skip changes. When next/finish is fired we can check stateChanged.
|
| textFont | | protected Font textFont(Code) | | |
| WizardPanel | | public WizardPanel(Composite parent, int style, WizardManager manager)(Code) | | Creates a new WizardPanel object.
Parameters:
parent -
Parameters:
style -
Parameters:
manager - |
| addDirtyListener | | public void addDirtyListener(IDirtyListener l)(Code) | | This method adds an IDirtyListener to our listener list
Parameters:
l - the IDirtyListener to add |
| backFired | | public void backFired(WizardPanel source)(Code) | | This method is called when the WizardManager is told to move to the previous step. This method is called on all listeners, so it may be important and useful for implements of this method in subclasses to filter out everything except
itself.
Parameters:
source - The WizardPanel that the back event originated from |
| cancelFired | | public boolean cancelFired(WizardPanel source)(Code) | | This method is called when the WizardManager is informed that the wizard is cancelled. This method is called on all listeners, so it may be important and useful for implements of this method in subclasses to filter out everything
except itself.
Parameters:
source - The WizardPanel that the finish event originated from |
| createContentPanel | | public Composite createContentPanel(int hSpan)(Code) | | This method creates the main panel composite used by Wizard Panels.
Composite the main panel |
| finishFired | | public void finishFired(WizardPanel source)(Code) | | This method is called when the WizardManager is told to finish. This method is called on all listeners, so it may be important and useful for implements of this method in subclasses to filter out everything except itself.
Parameters:
source - The WizardPanel that the finish event originated from |
| fireDirtyEvent | | public void fireDirtyEvent()(Code) | | Fires 'dirtyFired' on all listeners
|
| getMainPanel | | public Composite getMainPanel()(Code) | | This method gets the main panel (Composite).
Returns the mainPanel. |
| getWizardManager | | public WizardManager getWizardManager()(Code) | | This method gets the WizardManager for this WizardPanel
Returns the wizardManager. |
| initWizardPanel | | public void initWizardPanel()(Code) | | |
| initialize | | public void initialize(WizardManager manager)(Code) | | The initialize method creates the GUI
Parameters:
manager - WizardManager that we will add ourselves to listen on and hold reference to |
| isBackAllowed | | public boolean isBackAllowed()(Code) | | This method should be overridden by subclasses to return if we are allowed to move back (the default behavior here is to return true, which is likely acceptable most of the time).
boolean |
| isContinueAllowed | | public boolean isContinueAllowed()(Code) | | This method should be overridden by subclasses to return if we are allowed to move to the next step or finish.
boolean |
| isNextAllowed | | public boolean isNextAllowed()(Code) | | This method should be overridden by subclasses to return if we are allowed to move to the next step.
boolean |
| keyPressed | | public void keyPressed(KeyEvent e)(Code) | | This method is fired when a key is pressed on components we have added the WizardPanel as a KeyListener on.
Parameters:
e - |
| keyReleased | | public void keyReleased(KeyEvent e)(Code) | | This method is fired when a key is released on components we have added the WizardPanel as a KeyListener on.
Parameters:
e - |
| nextFired | | public boolean nextFired(WizardPanel source)(Code) | | This method is called when the WizardManager is told to move to the next step. This method is called on all listeners, so it may be important and useful for implements of this method in subclasses to filter out everything except
itself.
Parameters:
source - The WizardPanel that the next event originated from |
| previewFired | | public boolean previewFired(WizardPanel source)(Code) | | This method is called when the WizardManager is informed that the wizard is previewing. This method is called on all listeners, so it may be important and useful for implements of this method in subclasses to filter out everything
except itself.
Parameters:
source - The WizardPanel that the finish event originated from |
| removeAllDirtyListeners | | public void removeAllDirtyListeners()(Code) | | This method removes all IDirtyListeners from the event listener list
|
| removeDirtyListener | | public void removeDirtyListener(IDirtyListener l)(Code) | | This method removes an IDirtyListener from our listener list
Parameters:
l - the IDirtyListener to remove |
| setMainPanel | | public void setMainPanel(Composite mainPanel)(Code) | | This method sets the main panel (Composite).
Parameters:
mainPanel - The mainPanel to set. |
| setWizardManager | | public void setWizardManager(WizardManager wizardManager)(Code) | | This method sets the WizardManager for this WizardPanel
Parameters:
wizardManager - The wizardManager to set. |
| updateState | | public void updateState()(Code) | | This method updates the button enabled state as well as the overall panel enabled state. The buttons have their state updated based on checking if their action is allowed. If the previous wizard step does not allow continue then this
step should appear to be disabled (if a GUI, like tabs, allows you to select them).
|
| widgetDefaultSelected | | public void widgetDefaultSelected(SelectionEvent e)(Code) | | This method is necessary to implement when implementing SelectionListener and we do not use it.
Parameters:
e - |
| widgetSelected | | public void widgetSelected(SelectionEvent e)(Code) | | When any widget is selected, such as a button, a combobox, a checkbox, etc, we mark dirty/stateChanged unless the event originates from next/back/finish/cancel buttons.
Parameters:
e - |
|
|