Class NewServiceWizardPage
- java.lang.Object
-
- org.eclipse.jface.dialogs.DialogPage
-
- org.eclipse.jface.wizard.WizardPage
-
- org.libreoffice.ide.eclipse.core.wizards.pages.NewScopedElementWizardPage
-
- org.libreoffice.ide.eclipse.core.wizards.pages.NewServiceWizardPage
-
- All Implemented Interfaces:
org.eclipse.jface.dialogs.IDialogPage,org.eclipse.jface.dialogs.IMessageProvider,org.eclipse.jface.wizard.IWizardPage,IFieldChangedListener,IListenablePage
public class NewServiceWizardPage extends NewScopedElementWizardPage
Service creation wizard page.
-
-
Constructor Summary
Constructors Constructor Description NewServiceWizardPage(java.lang.String pPageName, IUnoidlProject pProject)Simple constructor setting the package root and element name to blank values.NewServiceWizardPage(java.lang.String pPageName, IUnoidlProject pProject, java.lang.String pRootName, java.lang.String pServiceName)Constructor setting allowing to set custom root package and service name.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcreateSpecificControl(org.eclipse.swt.widgets.Composite pParent)Implement this method to add specific controls for the subclassing wizard page.voidfieldChanged(FieldEvent pEvent)Method called when the row has changed.UnoFactoryDatafillData(UnoFactoryData pData)java.lang.StringgetDescription()UnoFactoryDatagetEmptyTypeData()Creates an empty factory data for the page UNO type.protected org.eclipse.jface.resource.ImageDescriptorgetImageDescriptor()java.lang.StringgetInheritanceName()Gets the name of the exported interface.intgetProvidedTypes()java.lang.StringgetTitle()protected java.lang.StringgetTypeLabel()booleanisInheritanceChanged()Tells whether the user has changed the exported interface since it has last been set using the APIs.voidsetInheritanceName(java.lang.String pValue, boolean pForced)Sets the name of the exported interface.-
Methods inherited from class org.libreoffice.ide.eclipse.core.wizards.pages.NewScopedElementWizardPage
addPageListener, createControl, dispose, existsIdlFile, firePageChanged, getElementName, getPackage, getPackageRoot, getProject, getTypeData, isPageComplete, isPublished, removePageListener, setName, setOOoInstance, setPackage, setPackageRoot, setPublished, setUnoidlProject, setVisible
-
Methods inherited from class org.eclipse.jface.wizard.WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
-
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage
-
-
-
-
Constructor Detail
-
NewServiceWizardPage
public NewServiceWizardPage(java.lang.String pPageName, IUnoidlProject pProject)Simple constructor setting the package root and element name to blank values.- Parameters:
pPageName- the page namepProject- the project where to create the service
-
NewServiceWizardPage
public NewServiceWizardPage(java.lang.String pPageName, IUnoidlProject pProject, java.lang.String pRootName, java.lang.String pServiceName)Constructor setting allowing to set custom root package and service name.- Parameters:
pPageName- the page namepProject- the project where to create the servicepRootName- the project root namespacepServiceName- the default service name
-
-
Method Detail
-
getProvidedTypes
public int getProvidedTypes()
- Specified by:
getProvidedTypesin classNewScopedElementWizardPage- Returns:
- the types to get in the UNO types provider. The returned integer is a
bit orof the types defined in theUnoTypeProviderclass.
-
createSpecificControl
public void createSpecificControl(org.eclipse.swt.widgets.Composite pParent)
Implement this method to add specific controls for the subclassing wizard page.- Specified by:
createSpecificControlin classNewScopedElementWizardPage- Parameters:
pParent- the composite parent where to put the controls
-
getTitle
public java.lang.String getTitle()
- Specified by:
getTitlein interfaceorg.eclipse.jface.dialogs.IDialogPage- Overrides:
getTitlein classorg.eclipse.jface.dialogs.DialogPage
-
getDescription
public java.lang.String getDescription()
- Specified by:
getDescriptionin interfaceorg.eclipse.jface.dialogs.IDialogPage- Overrides:
getDescriptionin classorg.eclipse.jface.dialogs.DialogPage
-
getTypeLabel
protected java.lang.String getTypeLabel()
- Specified by:
getTypeLabelin classNewScopedElementWizardPage- Returns:
- the string corresponding to the type name, e.g. "interface".
-
getImageDescriptor
protected org.eclipse.jface.resource.ImageDescriptor getImageDescriptor()
- Specified by:
getImageDescriptorin classNewScopedElementWizardPage- Returns:
- the image descriptor to put on the top-right of the page
-
fieldChanged
public void fieldChanged(FieldEvent pEvent)
Method called when the row has changed.- Specified by:
fieldChangedin interfaceIFieldChangedListener- Overrides:
fieldChangedin classNewScopedElementWizardPage- Parameters:
pEvent- the field event thrown
-
getInheritanceName
public java.lang.String getInheritanceName()
Gets the name of the exported interface.- Returns:
- the fully qualified name of the exported interface separated with "::"
-
setInheritanceName
public void setInheritanceName(java.lang.String pValue, boolean pForced)Sets the name of the exported interface.Use this method to impose the service to implement a particular interface. This is the case for an URE application.
- Parameters:
pValue- the interface fully qualified namepForced- disables the field iftrue
-
isInheritanceChanged
public boolean isInheritanceChanged()
Tells whether the user has changed the exported interface since it has last been set using the APIs.- Returns:
trueis the has changed the exported interface.
-
fillData
public UnoFactoryData fillData(UnoFactoryData pData)
- Overrides:
fillDatain classNewScopedElementWizardPage- Parameters:
pData- the data to fill- Returns:
- the given data with the completed properties,
nullif the provided data isnull
-
getEmptyTypeData
public UnoFactoryData getEmptyTypeData()
Creates an empty factory data for the page UNO type.- Specified by:
getEmptyTypeDatain classNewScopedElementWizardPage- Returns:
- the empty UNO factory data
-
-