Rule Execution Server API

ilog.rules.studio.res.ui.generator.impl.wizard.page
Class IlrFileGeneratorWizardSelectionPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.wizard.WizardPage
          extended by org.eclipse.jface.wizard.WizardSelectionPage
              extended by ilog.rules.studio.res.ui.generator.impl.wizard.page.IlrFileGeneratorWizardSelectionPage
All Implemented Interfaces:
org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
Direct Known Subclasses:
IlrRulesetReference

public abstract class IlrFileGeneratorWizardSelectionPage
extends org.eclipse.jface.wizard.WizardSelectionPage

Extends WizardSelectionPage to set the Client Project for RuleApps contextual help on the pages of the nested wizard.

Since:
JRules 6.5

Field Summary
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
IlrFileGeneratorWizardSelectionPage(String name)
          Creates a new wizard page with the given name, and with no title or image.
 
Method Summary
protected abstract  void addContent(org.eclipse.swt.widgets.Composite parent)
          Called by the redefined createControl final method to create the controls.
 void createControl(org.eclipse.swt.widgets.Composite parent)
          Redefines the createControl method, which creates a composite and sets the contextual help.
 void dispose()
          The IlrFileGeneratorWizardPage implementation of an DialogPage method that gets the control.
protected  String getHelpContextId()
          Gets the help context id declared in the documentation plug-in associated with this page.
protected  boolean isValidatedPageAtCreation()
          Called by the redefined createControl final method to know if the page is complete when it is created.
 void setVisible(boolean visible)
          The IlrRulesetParameterWizardPage implementation of this IDialogPage method fills the table with the ruleset parameter name and type.
 
Methods inherited from class org.eclipse.jface.wizard.WizardSelectionPage
canFlipToNextPage, getNextPage, getSelectedNode, setSelectedNode
 
Methods inherited from class org.eclipse.jface.wizard.WizardPage
getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp
 

Constructor Detail

IlrFileGeneratorWizardSelectionPage

public IlrFileGeneratorWizardSelectionPage(String name)
Creates a new wizard page with the given name, and with no title or image.

Parameters:
name - The name of the page.
Method Detail

getHelpContextId

protected String getHelpContextId()
Gets the help context id declared in the documentation plug-in associated with this page.

Returns:
The help context id.

setVisible

public void setVisible(boolean visible)
The IlrRulesetParameterWizardPage implementation of this IDialogPage method fills the table with the ruleset parameter name and type. Subclasses may extend.

Specified by:
setVisible in interface org.eclipse.jface.dialogs.IDialogPage
Overrides:
setVisible in class org.eclipse.jface.dialogs.DialogPage

createControl

public final void createControl(org.eclipse.swt.widgets.Composite parent)
Redefines the createControl method, which creates a composite and sets the contextual help.

To set your content, define the addContent method.

By default, the page is complete when it is created. If you do not want it, you can redefine the isValidatedPageAtCreation method and return false.


addContent

protected abstract void addContent(org.eclipse.swt.widgets.Composite parent)
Called by the redefined createControl final method to create the controls.

Parameters:
parent - The composite created in the createControl method.

isValidatedPageAtCreation

protected boolean isValidatedPageAtCreation()
Called by the redefined createControl final method to know if the page is complete when it is created.

Returns:
True if the page is complete at creation. False if the page is not complete at creation.

dispose

public void dispose()
The IlrFileGeneratorWizardPage implementation of an DialogPage method that gets the control.

Specified by:
dispose in interface org.eclipse.jface.dialogs.IDialogPage
Overrides:
dispose in class org.eclipse.jface.wizard.WizardSelectionPage

Rule Execution Server API

© Copyright IBM Corp. 1987, 2013