Class NewScopedElementWizardPage
- java.lang.Object
-
- org.eclipse.jface.dialogs.DialogPage
-
- org.eclipse.jface.wizard.WizardPage
-
- org.libreoffice.ide.eclipse.core.wizards.pages.NewScopedElementWizardPage
-
- All Implemented Interfaces:
org.eclipse.jface.dialogs.IDialogPage,org.eclipse.jface.dialogs.IMessageProvider,org.eclipse.jface.wizard.IWizardPage,IFieldChangedListener,IListenablePage
- Direct Known Subclasses:
NewInterfaceWizardPage,NewServiceWizardPage
public abstract class NewScopedElementWizardPage extends org.eclipse.jface.wizard.WizardPage implements IFieldChangedListener, IListenablePage
Abstract class for a wizard page to create a scoped element such as a service or an interface.
-
-
Constructor Summary
Constructors Constructor Description NewScopedElementWizardPage(java.lang.String pName)Default constructor to use when neither the project nor the OOo instance is known.NewScopedElementWizardPage(java.lang.String pPageName, java.lang.String pRootName, java.lang.String pElementName, IOOo pOOoInstance)Constructor to use when the UNO project is already created, the scoped type name and it's path already known.NewScopedElementWizardPage(java.lang.String pPageName, IOOo pOOoInstance)Creates a default scoped name type wizard page with blank container path and type name.NewScopedElementWizardPage(java.lang.String pPageName, IUnoidlProject pUnoProject)Constructor to use when the UNO project is already created.NewScopedElementWizardPage(java.lang.String pPageName, IUnoidlProject pProject, java.lang.String pRootName, java.lang.String pElementName)Constructor to use when the UNO project is already created, the scoped type name and it's path already known.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidaddPageListener(IPageListener pListener)Add the page listener.voidcreateControl(org.eclipse.swt.widgets.Composite pParent)protected abstract voidcreateSpecificControl(org.eclipse.swt.widgets.Composite pParent)Implement this method to add specific controls for the subclassing wizard page.voiddispose()static booleanexistsIdlFile(java.lang.String pIdlFullName, IUnoidlProject pPrj)Checks if an IDL file exists in the project for a given IDL type.voidfieldChanged(FieldEvent pEvent)Method called when the row has changed.UnoFactoryDatafillData(UnoFactoryData pData)protected voidfirePageChanged(UnoFactoryData pData)Notifies all the page listeners that the pages data have changed.java.lang.StringgetElementName()abstract UnoFactoryDatagetEmptyTypeData()Creates an empty factory data for the page UNO type.protected abstract org.eclipse.jface.resource.ImageDescriptorgetImageDescriptor()java.lang.StringgetPackage()java.lang.StringgetPackageRoot()IUnoidlProjectgetProject()abstract intgetProvidedTypes()static UnoFactoryDatagetTypeData(UnoFactoryData pData)protected abstract java.lang.StringgetTypeLabel()booleanisPageComplete()booleanisPublished()voidremovePageListener(IPageListener pListener)Remove the page listener.voidsetName(java.lang.String pValue, boolean pForced)Sets the name of the element to create.voidsetOOoInstance(IOOo pOOoInstance)Set the OOo instance to query the types from.voidsetPackage(java.lang.String pValue, boolean pForced)the container name of the type to create is composed of two parts: the package root and the package.voidsetPackageRoot(java.lang.String pValue)The container name of the type to create is composed of two parts: the package root and the package; this method sets the first part.voidsetPublished(boolean pValue, boolean pForced)Sets whether the type is published or not.voidsetUnoidlProject(IUnoidlProject pUnoProject)Sets the UNO project in which to create the scoped name type.voidsetVisible(boolean pVisible)-
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, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage
-
-
-
-
Constructor Detail
-
NewScopedElementWizardPage
public NewScopedElementWizardPage(java.lang.String pName)
Default constructor to use when neither the project nor the OOo instance is known.- Parameters:
pName- wizard page name
-
NewScopedElementWizardPage
public NewScopedElementWizardPage(java.lang.String pPageName, IUnoidlProject pUnoProject)Constructor to use when the UNO project is already created.- Parameters:
pPageName- name of the pagepUnoProject- UNO project in which to create a scoped type
-
NewScopedElementWizardPage
public NewScopedElementWizardPage(java.lang.String pPageName, IUnoidlProject pProject, java.lang.String pRootName, java.lang.String pElementName)Constructor to use when the UNO project is already created, the scoped type name and it's path already known.- Parameters:
pPageName- name of the wizard pagepProject- UNO project in which to create a scoped typepRootName- scoped name of the module containing the typepElementName- name of the type, without any '.' or '::'
-
NewScopedElementWizardPage
public NewScopedElementWizardPage(java.lang.String pPageName, IOOo pOOoInstance)Creates a default scoped name type wizard page with blank container path and type name.- Parameters:
pPageName- name of the wizard pagepOOoInstance- the OOo instance to use to retrieve the types
-
NewScopedElementWizardPage
public NewScopedElementWizardPage(java.lang.String pPageName, java.lang.String pRootName, java.lang.String pElementName, IOOo pOOoInstance)Constructor to use when the UNO project is already created, the scoped type name and it's path already known.- Parameters:
pPageName- name of the wizard pagepRootName- scoped name of the module containing the typepElementName- name of the type, without any '.' or '::'pOOoInstance- the reference to the OOo to use for type selection
-
-
Method Detail
-
getProject
public IUnoidlProject getProject()
- Returns:
- the project which has been set to the page
-
getTypeLabel
protected abstract java.lang.String getTypeLabel()
- Returns:
- the string corresponding to the type name, e.g. "interface".
-
getImageDescriptor
protected abstract org.eclipse.jface.resource.ImageDescriptor getImageDescriptor()
- Returns:
- the image descriptor to put on the top-right of the page
-
createSpecificControl
protected abstract void createSpecificControl(org.eclipse.swt.widgets.Composite pParent)
Implement this method to add specific controls for the subclassing wizard page.- Parameters:
pParent- the composite parent where to put the controls
-
getProvidedTypes
public abstract int getProvidedTypes()
- Returns:
- the types to get in the UNO types provider. The returned integer is a
bit orof the types defined in theUnoTypeProviderclass.
-
setOOoInstance
public void setOOoInstance(IOOo pOOoInstance)
Set the OOo instance to query the types from.- Parameters:
pOOoInstance- OOo instance to use.
-
setUnoidlProject
public void setUnoidlProject(IUnoidlProject pUnoProject)
Sets the UNO project in which to create the scoped name type.- Parameters:
pUnoProject- the projet for which to create the UNO type.
-
getPackageRoot
public java.lang.String getPackageRoot()
- Returns:
- the root module where to create the UNO type.
-
getPackage
public java.lang.String getPackage()
- Returns:
- the module containing the UNO type, separated by "::".
-
getElementName
public java.lang.String getElementName()
- Returns:
- the name of the element to create.
-
setPackageRoot
public void setPackageRoot(java.lang.String pValue)
The container name of the type to create is composed of two parts: the package root and the package; this method sets the first part.- Parameters:
pValue- the new package root to set
-
setPackage
public void setPackage(java.lang.String pValue, boolean pForced)the container name of the type to create is composed of two parts: the package root and the package. This method sets the second part.- Parameters:
pValue- the new package valuepForced-truewill replace the current value,falsewill set the value only if the current package is empty ornull.
-
setName
public void setName(java.lang.String pValue, boolean pForced)Sets the name of the element to create.- Parameters:
pValue- the new package valuepForced-truewill replace the current value,falsewill set the value only if the current package is empty ornull.
-
isPublished
public boolean isPublished()
- Returns:
- whether the service is published or not.
-
setPublished
public void setPublished(boolean pValue, boolean pForced)Sets whether the type is published or not.- Parameters:
pValue-trueif the type is published,falseotherwisepForced-trueto overwrite the existing value.
-
dispose
public void dispose()
- Specified by:
disposein interfaceorg.eclipse.jface.dialogs.IDialogPage- Overrides:
disposein classorg.eclipse.jface.dialogs.DialogPage
-
addPageListener
public void addPageListener(IPageListener pListener)
Add the page listener.- Specified by:
addPageListenerin interfaceIListenablePage- Parameters:
pListener- the page listener to add
-
removePageListener
public void removePageListener(IPageListener pListener)
Remove the page listener.- Specified by:
removePageListenerin interfaceIListenablePage- Parameters:
pListener- the listener to remove.
-
firePageChanged
protected void firePageChanged(UnoFactoryData pData)
Notifies all the page listeners that the pages data have changed.- Parameters:
pData- the new data of the page.
-
createControl
public void createControl(org.eclipse.swt.widgets.Composite pParent)
- Specified by:
createControlin interfaceorg.eclipse.jface.dialogs.IDialogPage
-
setVisible
public void setVisible(boolean pVisible)
- Specified by:
setVisiblein interfaceorg.eclipse.jface.dialogs.IDialogPage- Overrides:
setVisiblein classorg.eclipse.jface.dialogs.DialogPage
-
fillData
public UnoFactoryData fillData(UnoFactoryData pData)
- Parameters:
pData- the UNO data to complete- Returns:
- the given data with the completed properties,
nullif the provided data isnull
-
getEmptyTypeData
public abstract UnoFactoryData getEmptyTypeData()
Creates an empty factory data for the page UNO type.- Returns:
- the empty UNO factory data
-
getTypeData
public static UnoFactoryData getTypeData(UnoFactoryData pData)
- Parameters:
pData- the data of the project for which to get the default type data.- Returns:
- the default type data for the project
-
fieldChanged
public void fieldChanged(FieldEvent pEvent)
Method called when the row has changed.- Specified by:
fieldChangedin interfaceIFieldChangedListener- Parameters:
pEvent- the field event thrown
-
isPageComplete
public boolean isPageComplete()
- Specified by:
isPageCompletein interfaceorg.eclipse.jface.wizard.IWizardPage- Overrides:
isPageCompletein classorg.eclipse.jface.wizard.WizardPage
-
existsIdlFile
public static boolean existsIdlFile(java.lang.String pIdlFullName, IUnoidlProject pPrj)Checks if an IDL file exists in the project for a given IDL type.Please note that this method behaves correctly only if the user is respecting the following design rules:
- One IDL type per file
- The IDL types have to be organized in directories representing the UNO modules
- Parameters:
pIdlFullName- the full name of the IDL file checkpPrj- the project where to look for the IDL file- Returns:
trueif the an IDL file corresponds to the searched type,falseotherwise.
-
-