|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DesignerProject
This object represents a Lotus Notes/Domino application (or in the Eclipse terminology, project). It does not extend IProject (but you can get the IProject from it or vice versa).
Method Summary | |
---|---|
java.lang.String |
getDatabaseName()
The filepath of the application. |
java.lang.String |
getDatabaseTitle()
The title is an attribute of the application, and can contain any characters. |
DesignerDesignElement |
getDesignElement(org.eclipse.core.runtime.IPath path)
If you know or can invent the path of a design element you think exists, this returns a "handle" to the design element that can be used to read and set its properties. |
DesignerDesignElement[] |
getDesignElements(java.lang.String designElementTypeID)
|
FacesRegistry |
getFacesRegistry()
THIS IS A BETA LEVEL API AND IS SUBJECT TO CHANGE! Returns an instance of the FacesRegistry that describes the current application.The FacesRegistry contains all of the meta information relating to a particular application and the XPages runtime. |
org.eclipse.core.resources.IFile[] |
getFilesOfType(java.lang.String designElementTypeID)
Returns an array of type IFile which represents the design elements of the specified type. |
java.lang.String |
getInheritTemplateName()
Returns which template this application inherits its design from. |
java.lang.String |
getMasterTemplateName()
If application is a template, the "template name" by which other applications can inherit its design (null = none). |
org.eclipse.core.resources.IProject |
getProject()
The IProject object allows access to properties which are common to all projects, such as the Eclipse path of the project. |
java.lang.String |
getProjectNotesURL()
Returns the Notes URL of the application, which is useful in Composite Applications etc. |
java.lang.String |
getReplicaId()
The replica ID is a 16-hex-digit string, useful for locating replicas of the application on other servers or for concocting non-server-specific URIs of the application. |
java.lang.String |
getServerCommonName()
Retrieves the server "common name", or null for a local application. |
java.lang.String |
getServerName()
Retrieves the fully-qualified, abbreviated server name, or null for a local application. |
org.eclipse.core.resources.IFolder |
getWebContentFolder()
Returns the IFolder reference to Web Content Folder within the nsf, which is not visible in the navigator UI, but where XPage compilation stores various files resulting from the build process. |
void |
initialize()
Ensure that the project is fully loaded into Eclipse, so that all resources can be found if they're in there. |
boolean |
isDesignHidden()
A "hidden" design has all the source code stripped out of it, and the user isn't allowed to edit it in Domino Designer. |
boolean |
isDesignLockingAllowed()
A database option controlling whether design elements are "locked" when someone starts editing them, to prevent simultaneous edits. |
boolean |
isInheritTemplate()
True if the design of the application is "inherited" from a template. |
boolean |
isMultiLingual()
A multilingual application can potentially contain multiple design elements with the same alias, one for each language the application supports. |
boolean |
isProjectAccessible()
Has the project been initialized for use in this session? "Accessible" in this context doesn't mean whether the user has access to it. |
java.lang.String |
notesDbExists()
Tells whether the application referred to by the project actually exists and is available. |
void |
refresh()
Update the UI to reflect recent changes to design elements or properties. |
void |
setInheritTemplateName(java.lang.String inheritTemplateName)
Change which template this application inherits its design from; null or "" = does not inherit. |
void |
setMasterTemplateName(java.lang.String masterTemplatename)
Assign the "template ID" which identifies this application as a template. |
void |
setTitle(java.lang.String dbtitle)
Sets the database title. |
Method Detail |
---|
java.lang.String getServerName()
java.lang.String getServerCommonName()
java.lang.String getReplicaId()
java.lang.String getDatabaseName()
java.lang.String getDatabaseTitle()
void setTitle(java.lang.String dbtitle) throws DesignerException
new
- database title. Null and "" are not legal values.dbtitle
- the new title of the db
DesignerException
boolean isDesignLockingAllowed()
java.lang.String notesDbExists()
null
if application exists, otherwise a string (message) describing the error.boolean isProjectAccessible()
initialize()
method.
initialize()
boolean isMultiLingual()
boolean isInheritTemplate()
setInheritTemplateName(java.lang.String)
boolean isDesignHidden()
org.eclipse.core.resources.IFolder getWebContentFolder()
org.eclipse.core.resources.IProject getProject()
IProject
java.lang.String getProjectNotesURL() throws DesignerException
DesignerException
void refresh() throws DesignerException
DesignerException
DesignerDesignElement getDesignElement(org.eclipse.core.runtime.IPath path)
path
- the location of the design element
isProjectAccessible()
,
initialize()
void initialize() throws DesignerException
isProjectAccessible
.
It does no harm to proactively initialize an application you're about to access; if it's already
initialized nothing happens. If your selection includes design elements, the project containing the design
elements is already initialized.
DesignerException
java.lang.String getMasterTemplateName() throws DesignerException
DesignerException
void setMasterTemplateName(java.lang.String masterTemplatename) throws DesignerException
masterTemplatename
- null
or "" (empty string) to clear the value, else any string to be the unique ID for
this template.
DesignerException
java.lang.String getInheritTemplateName() throws DesignerException
DesignerException
getMasterTemplateName()
void setInheritTemplateName(java.lang.String inheritTemplateName) throws DesignerException
inheritTemplateName
- the name of the template from which this one is to inherit its design
DesignerException
org.eclipse.core.resources.IFile[] getFilesOfType(java.lang.String designElementTypeID)
IFile
which represents the design elements of the specified type.
For more information on the possible values of DesignerResource
designElementTypeID
- - A java.util.String constant which represents the ID of the type of Design
Element which you wish to lookup.
IFile
. The elements in the array are the Eclipse File System
representation of the Domino Designer Design Elements.FacesRegistry getFacesRegistry()
FacesRegistry
that describes the current application.
FacesRegistry
DesignerDesignElement[] getDesignElements(java.lang.String designElementTypeID)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |