| java.lang.Object
 org.netbeans.installer.wizard.components.WizardComponent
All known Subclasses: org.netbeans.installer.wizard.components.WizardAction, org.netbeans.installer.wizard.components.WizardPanel, org.netbeans.installer.wizard.components.WizardSequence,
| WizardComponent | | abstract public class WizardComponent (Code) | | This class represents a single unit of a
Wizard sequence. It is a logical
abstraction of a wizard step, should normally be accompanied by a
WizardUi instance.
This class provides a bunch of methods which are used by the wizard in order to
execute the component, devise whether is can be executed or can be skipped,
whether the user is allowed to skip the component, etc.
The basic infrastructure used by the concrete implementations of the
WizardComponent class is also defined here: support for child components
and properties.
author:
Kirill Sorokin
since:
1.0 |
| Inner Class :public static class WizardComponentUi implements WizardUi | |
| Inner Class :public static class WizardComponentSwingUi extends SwingUi | |
| BACK_BUTTON_TEXT_PROPERTY | | final public static String BACK_BUTTON_TEXT_PROPERTY(Code) | | Name of the property, which contains the text for the standard 'Back'
button.
|
| CANCEL_BUTTON_TEXT_PROPERTY | | final public static String CANCEL_BUTTON_TEXT_PROPERTY(Code) | | Name of the property, which contains the text for the standard 'Cancel'
button.
|
| DESCRIPTION_PROPERTY | | final public static String DESCRIPTION_PROPERTY(Code) | | Name of the property, which contains the component's description.
|
| FINISH_BUTTON_TEXT_PROPERTY | | final public static String FINISH_BUTTON_TEXT_PROPERTY(Code) | | Name of the property, which contains the text for the standard 'Finish'
button.
|
| HELP_BUTTON_TEXT_PROPERTY | | final public static String HELP_BUTTON_TEXT_PROPERTY(Code) | | Name of the property, which contains the text for the standard 'Help'
button.
|
| NEXT_BUTTON_TEXT_PROPERTY | | final public static String NEXT_BUTTON_TEXT_PROPERTY(Code) | | Name of the property, which contains the text for the standard 'Next'
button.
|
| RESOURCE_CANCEL_DIALOG_TEXT | | final public static String RESOURCE_CANCEL_DIALOG_TEXT(Code) | | Name of a resource bundle entry.
|
| RESOURCE_CANCEL_DIALOG_TITLE | | final public static String RESOURCE_CANCEL_DIALOG_TITLE(Code) | | Name of a resource bundle entry.
|
| TITLE_PROPERTY | | final public static String TITLE_PROPERTY(Code) | | Name of the property, which contains the component's title.
|
| WizardComponent | | protected WizardComponent()(Code) | | Creates a new instance of
WizardComponent . This is the default
protected constructor which must be called by the concrete
implementations. It initializes the fields above and sets some default
properties.
|
| addChild | | final public void addChild(WizardComponent component)(Code) | | Registers a new child for this component.
Parameters:
component - New child component which should be registered. |
| addChildren | | final public void addChildren(List<WizardComponent> components)(Code) | | Registers several children for this component.
Parameters:
components - List of child components which should beregistered. |
| canExecuteBackward | | public boolean canExecuteBackward()(Code) | | This method is called by the wizard in order to find out whether this
component can be reached via
Wizard.previous .
It's important to note that if this method returns false, the
wizard will not assume that it cannot proceed, but will skip this
component altogether.
true if the component can be executed,false if the component should be skipped. |
| canExecuteForward | | public boolean canExecuteForward()(Code) | | This method is called by the wizard in order to find out whether this
component can be reached via
Wizard.next .
It's important to note that if this method returns false, the
wizard will not assume that it cannot proceed, but will skip this
component altogether.
true if the component can be executed,false if the component should be skipped. |
| getChildren | | final public List<WizardComponent> getChildren()(Code) | | Returns the list of currently registered child components. It is not
guaranteed that operating on this list directly will affect the actual
children.
List of the registered child components. |
| getProperties | | final public NbiProperties getProperties()(Code) | | Returns the properties of this component. The values of the properties will
not be parsed. It is not guaranteed that operating on the return value of
this method will affect the actual properties of the component.
Component's properties. |
| getProperty | | final public String getProperty(String name, boolean resolve)(Code) | | Returns the value of the specified property. Thsi method can either attempt
to resolve the value, or return it as is.
Parameters:
name - Name of the property whose value needs to be returned.
Parameters:
resolve - Whether to resolve the property value or not. Value of the specified property, either parsed or not. |
| getString | | final protected String getString(String baseName, String key, Object... arguments)(Code) | | A helper method - calls
ResourceUtils.getString(StringStringClassLoaderObject[]) ,
supplying
Wizard.getClassLoader as the class loader value.
Parameters:
baseName - Resource bundle base name.
Parameters:
key - Name of the key whose value needs to be obtained.
Parameters:
arguments - Objects which should be used to substitute wildcards in thekey value. Value of the specified key from the specified bundle with itswildcards resolved using the supplied arguments. |
| getWizard | | final public Wizard getWizard()(Code) | | Returns the
Wizard which currently executes this component.
Wizard which currently executes this component. |
| isPointOfNoReturn | | public boolean isPointOfNoReturn()(Code) | | This method is called by the wizard in order to find out whether it is
allowed to execute any components before this via the
Wizard.previous method. If this method returns true it
will be illegal to call
Wizard.previous if the current component
is active.
true is the component is the point of no return,false otherwise. |
| removeChild | | final public void removeChild(WizardComponent component)(Code) | | Unregisters a child component. If it was not previously registered, no action
is taken.
Parameters:
component - Child component which should be unregistered. |
| setProperty | | final public void setProperty(String name, String value)(Code) | | Sets the specified property to the specified value. If such property does not
exist - it is created.
Parameters:
name - Name of the property whose value needs to be set.
Parameters:
value - Value of the property. |
| setWizard | | final public void setWizard(Wizard wizard)(Code) | | Sets the
Wizard which currently executes this component.
Parameters:
wizard - Wizard which currently executes this component. |
|
|