|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IUnoidlProject
Interface for a UNO project.
Field Summary | |
---|---|
static java.lang.String |
DESCRIPTION_FILENAME
|
static java.lang.String |
IDL_FOLDER
org.openoffice.ide.eclipse.idlfolder is a
persistent folder property that determines whether the
folder can contain unoidl files or not. |
static java.lang.String |
XCS_EXTENSION
|
static java.lang.String |
XCU_EXTENSION
|
Method Summary | |
---|---|
void |
dispose()
Cleans up the project before destroying it. |
org.eclipse.core.resources.IFolder[] |
getBinFolders()
|
org.eclipse.core.runtime.IPath |
getBuildPath()
|
java.lang.String |
getCompanyPrefix()
Returns the company prefix used in the idl modules and implementation trees. |
org.eclipse.core.resources.IFolder |
getDistFolder()
|
org.eclipse.core.runtime.IPath |
getDistPath()
|
org.eclipse.core.resources.IFile |
getFile(org.eclipse.core.runtime.IPath pPath)
Returns the file handle for the given project relative path. |
org.eclipse.core.resources.IFile |
getFile(java.lang.String pPath)
Returns the file handle for the given project relative path. |
org.eclipse.core.resources.IFolder |
getFolder(org.eclipse.core.runtime.IPath pPath)
Returns the folder handle for the given project relative path. |
org.eclipse.core.resources.IFolder |
getFolder(java.lang.String pPath)
Returns the folder handle for the given project relative path. |
org.eclipse.core.runtime.IPath |
getIdlPath()
|
org.eclipse.core.runtime.IPath |
getImplementationPath()
|
AbstractLanguage |
getLanguage()
|
java.lang.String |
getName()
|
IOOo |
getOOo()
|
org.eclipse.core.resources.IFolder |
getOpenOfficeUserProfileFolder()
|
org.eclipse.core.runtime.IPath |
getOpenOfficeUserProfilePath()
|
java.lang.String |
getOutputExtension()
Returns the package or namespace name used for the implementation. |
org.eclipse.core.runtime.IPath |
getProjectPath()
|
java.lang.String |
getProperty(java.lang.String pName)
Get a project's property. |
java.lang.String |
getRootModule()
Gets the root module of the project. |
org.eclipse.core.runtime.IPath |
getRootModulePath()
Gets the root module path of the project. |
ISdk |
getSdk()
|
org.eclipse.core.runtime.IPath |
getServicesPath()
|
org.eclipse.core.runtime.IPath |
getSourcePath()
|
org.eclipse.core.runtime.IPath |
getTypesPath()
|
org.eclipse.core.runtime.IPath |
getUrdPath()
|
void |
saveAllProperties()
Saves the UNO project configuration in a hidden file. |
void |
setCompanyPrefix(java.lang.String pPrefix)
Sets the company prefix. |
void |
setIdlDir(java.lang.String pIdlDir)
Defines the directory containing the IDL files. |
void |
setLanguage(AbstractLanguage pLanguage)
Set the language of the project implementation. |
void |
setOOo(IOOo pOOo)
Sets the selected OOo. |
void |
setOutputExtension(java.lang.String pOutputExt)
Sets the output extension. |
void |
setProperty(java.lang.String pName,
java.lang.String pValue)
Set a property to the project. |
void |
setSdk(ISdk pSdk)
Sets the selected SDK. |
void |
setSourcesDir(java.lang.String pSourcesDir)
Defines the directory containing the sources. |
Field Detail |
---|
static final java.lang.String DESCRIPTION_FILENAME
static final java.lang.String IDL_FOLDER
org.openoffice.ide.eclipse.idlfolder
is a
persistent folder property that determines whether the
folder can contain unoidl files or not.
static final java.lang.String XCS_EXTENSION
static final java.lang.String XCU_EXTENSION
Method Detail |
---|
void dispose()
AbstractLanguage getLanguage()
java.lang.String getName()
IOOo getOOo()
ISdk getSdk()
void setLanguage(AbstractLanguage pLanguage)
pLanguage
- the new languagevoid setOOo(IOOo pOOo)
pOOo
- the selected OpenOffice.orgvoid setSdk(ISdk pSdk)
pSdk
- the selected SDKvoid setProperty(java.lang.String pName, java.lang.String pValue)
This can be used by plugins to set their own properties on the project.
pName
- the property namepValue
- the property valuejava.lang.String getProperty(java.lang.String pName)
This can be used by plugins to get their own properties from the project.
pName
- the property name
null
if it doesn't
existsjava.lang.String getRootModule()
It corresponds to the prefix transformed as an idl scoped name. For example, if
the company prefix is set to foo.bar
, the root module will be
foo::bar
.
org.eclipse.core.runtime.IPath getRootModulePath()
It corresponds to the path to the root module definition. For example, if
the company prefix is set to foo.bar
, the root module path will be
idl/foo/bar
.
void setCompanyPrefix(java.lang.String pPrefix)
pPrefix
- new company prefixjava.lang.String getCompanyPrefix()
org.openoffice
for any code
created by the OpenOffice.org community.
void setOutputExtension(java.lang.String pOutputExt)
pOutputExt
- new output extension to setjava.lang.String getOutputExtension()
If the company prefix is org.openoffice
and the output
extension is comp
, then the implementation namespace will be:
org.openoffice.comp
.
org.eclipse.core.runtime.IPath getBuildPath()
org.eclipse.core.runtime.IPath getIdlPath()
org.eclipse.core.runtime.IPath getImplementationPath()
org.eclipse.core.runtime.IPath getProjectPath()
org.eclipse.core.runtime.IPath getSourcePath()
org.eclipse.core.runtime.IPath getTypesPath()
types.rdb
file. This path is
relative to the project folder.org.eclipse.core.runtime.IPath getServicesPath()
services.rdb
file. This path
is relative to the project folder.org.eclipse.core.runtime.IPath getUrdPath()
org.eclipse.core.runtime.IPath getDistPath()
org.eclipse.core.resources.IFolder getDistFolder() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException
- if we were unable to create the folder.org.eclipse.core.runtime.IPath getOpenOfficeUserProfilePath()
org.eclipse.core.resources.IFolder getOpenOfficeUserProfileFolder() throws org.eclipse.core.runtime.CoreException
org.eclipse.core.runtime.CoreException
- if we were unable to create the folder.org.eclipse.core.resources.IFile getFile(org.eclipse.core.runtime.IPath pPath)
null
.
pPath
- the path to the folder to get
null
IProject.getFile(java.lang.String)
org.eclipse.core.resources.IFile getFile(java.lang.String pPath)
null
.
pPath
- the path to the folder to get
null
IProject.getFile(java.lang.String)
org.eclipse.core.resources.IFolder getFolder(org.eclipse.core.runtime.IPath pPath)
null
.
pPath
- the path to the folder to get
null
IProject.getFolder(java.lang.String)
org.eclipse.core.resources.IFolder getFolder(java.lang.String pPath)
null
.
pPath
- the path to the folder to get
null
IProject.getFolder(java.lang.String)
void setIdlDir(java.lang.String pIdlDir)
pIdlDir
- the IDL directoryvoid setSourcesDir(java.lang.String pSourcesDir)
pSourcesDir
- the sources directoryvoid saveAllProperties()
org.eclipse.core.resources.IFolder[] getBinFolders()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |