Package org.eclnt.editor.tools
Class ProjectInfo
java.lang.Object
org.eclnt.editor.tools.ProjectInfo
Information about the project that is currently inside editor. This
information is normally not required for runtime purposes - but is required
when developing add-ons for the layout editor.
-
Nested Class Summary
Modifier and TypeClassDescriptionclass
class
static class
static class
static class
static class
static interface
static interface
class
class
class
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddAdditionalResourceInfo
(String package1, String name, String expressionprefix) void
addEmbeddedFunctions
(String className, boolean errorIfNotAvailable) void
addLibrary
(ProjectInfo.DesignTimeTLDInfo library) addManagedBeanInfoDT
(String name, String className) void
addPackageAbbreviation
(String packageName, String abbreviation) addPageBeanCopyInfo
(String jspDirectory, String javaPackage) void
void
addTemplateInfo
(String resource, String image) boolean
checkIfAttributeIsManagedByStyle
(String componentName, String attributeName, String stylevariantName) void
clear()
void
void
createAdditionalDeployInfo
(String fromdir, String fromzip, String todir, String ignorecsv, boolean ignoreDuringHotDeployment) boolean
If true then the "clean&deploy" option is active in the layout editor.boolean
Defines if a version update through the CaptainCasa toolset is allowed or not.Class loader name that is used within the bean browser.boolean
Extensions to the class path - semicolon separated list of directories or jar files.int
A command line that is executed if the file (e.g. jsp-page) that is written within the CaptainCasa toolkit is read-only.String[]
File that - if defined - is written when deploying through the CaptainCasa toolset.The directory where the compiled UI classes (managed beans/ backing beans) are located.The directory containing the classes that are comiled fromgetJavasourcewebinfdirectory()
.The java source directory - where the bean structure editor writes its sources to.The directory containing the sources that are compiled into WEB-INF/classes.boolean
boolean
Collection of control libraries.boolean
getName()
Name of the project - this is the name of the file within the editor/config/projects-directory of the tool web application.The main directory of the development project.Directory in which property files (multi language management) are stored.boolean
If true then property files are saved as UTF8 text files - and not as special property files with escaped characters.boolean
Flag that indicates that the web application is realoded.boolean
boolean
getStyleDirectoryName
(String styleName) getStyleVariantsForComponent
(String componentName) Find style variants that are defined for a given component within the default style of the project.boolean
Flag that indicates that project uses hot deployment of CaptainCasa toolkit.getWebappaddonsdirectory
(boolean withDefaulting) Name of the directory in which the webappaddons-files are stored within the project.The target directory for copying the web content, when executing a reload in the toolkit.The directory which is copied into the runtime when executing a reload in the toolkit.The directory where web-resources are stored.The context root for building the preview URL in the toolkit.The host and port for building the preview URL in the toolkit.getXml()
boolean
Flag that indicates that a copy of webcontent is executed when executing a reload in the toolkit.boolean
void
pageLoaded
(String pageName) This functions is called when a page is shown within the layout editor.void
reloadProject
(Object trigger) void
void
void
setAllowclean
(boolean allowclean) void
setAllowversionupdatebytoolset
(boolean allowversionupdate) void
setAxis2Home
(String axis2Home) void
setBeanBrowserClassLoader
(String beanBrowserClassLoader) void
setCheckForUpdateFiles
(String value) void
setClassPathExtension
(String classPathExtension) void
setCodegeneratorIndent
(int codegeneratorIndent) void
setCodegeneratorMemberprefix
(String codegeneratorPropertyprefix) void
setCodegeneratorMembervisibility
(String codegeneratorMembervisibility) void
setCodegeneratorUIClassSuffix
(String codegeneratorUIClassSuffix) void
void
setCopywebapp
(String copywebapp) void
setCopywebappIgnore
(String[] copywebappIgnore) void
setCurrentPageName
(String value) void
setDeployinfofilename
(String deployinfofilename) void
setDispatchername
(String value) void
setExpressionManager
(String value) void
setHtPdaStylePath
(String htPdaStylePath) void
setHtStylePath
(String htStylePath) void
setJavaclassdirectory
(String javaclassdirectory) void
setJavaclasswebinfdirectory
(String javaclasswebinfdirectory) void
setJavasourcedirectory
(String javasourcedirectory) for testing purposes only!void
setJavaSourceEncoding
(String javaSourceEncoding) void
setJavasourcewebinfdirectory
(String javasourcewebinfdirectory) void
setKeepGeneratedIds
(boolean value) void
setLayoutDefinitionsSavedAsXml
(boolean layoutDefinitionsSavedAsXml) void
setLibraries
(List<ProjectInfo.DesignTimeTLDInfo> libraries) void
setManagedByCCToolSet
(boolean projectIsManagedByCCToolSet) void
void
void
setPreviewbgpaint
(String previewbgpaint) void
setProjectdirectory
(String value) void
setProjectFileName
(String projectFileName) void
setProjectfileStoredInProjectDirectory
(boolean projectfileStoredInProjectDirectory) void
setPropertyfilesdirectory
(String propertyfilesdirectory) void
setPropertyFilesUTF8
(boolean propertyFilesUTF8) void
setReloadwebapp
(String reloadwebapp) void
setResourcesInSource
(boolean resourcesInSource) void
setResourcesInWebContent
(boolean resourcesInWebContent) void
setRuntimeServletTempDirectory
(String runtimeServletTempDirectory) void
setTemplates
(List<ProjectInfo.TemplateInfo> templates) void
setUitestcasedirectory
(String value) void
setWebappaddonsdirectory
(String webappaddonsdirectory) void
setWebcontentdeploydirectory
(String webcontentdeploydirectory) void
setWebcontentdeployfromdirectory
(String webcontentdeployfromdirectory) void
setWebcontentdirectory
(String webcontentdirectory) for testing purposes only!void
setWebcontextroot
(String webcontextroot) void
setWebhostport
(String webhostport) void
setWebprotocol
(String webprotocol) void
void
void
updateCurrentDesignTimeClassLoaders
(ClassLoader cl, ClassLoader independentCl)
-
Constructor Details
-
ProjectInfo
public ProjectInfo()
-
-
Method Details
-
updateCurrentDesignTimeClassLoaders
-
getEmbeddedFunctions
-
getCurrentDesignTimeClassLoader
-
getCurrentDesignTimeIndependentClassLoader
-
getLayoutDefinitionsSavedAsXml
public boolean getLayoutDefinitionsSavedAsXml() -
setLayoutDefinitionsSavedAsXml
public void setLayoutDefinitionsSavedAsXml(boolean layoutDefinitionsSavedAsXml) -
getPropertyFilesUTF8
public boolean getPropertyFilesUTF8()If true then property files are saved as UTF8 text files - and not as special property files with escaped characters. -
setPropertyFilesUTF8
public void setPropertyFilesUTF8(boolean propertyFilesUTF8) -
getName
Name of the project - this is the name of the file within the editor/config/projects-directory of the tool web application. -
getBeanBrowserClassLoader
Class loader name that is used within the bean browser. -
setBeanBrowserClassLoader
-
isProjectfileStoredInProjectDirectory
public boolean isProjectfileStoredInProjectDirectory() -
setProjectfileStoredInProjectDirectory
public void setProjectfileStoredInProjectDirectory(boolean projectfileStoredInProjectDirectory) -
getProjectdirectory
The main directory of the development project. -
getWebcontentdirectory
The directory where web-resources are stored. -
getWebcontentdeployfromdirectory
The directory which is copied into the runtime when executing a reload in the toolkit. By default is the same is thegetWebcontentdirectory()
. -
getWebcontentdeploydirectory
The target directory for copying the web content, when executing a reload in the toolkit. -
getWebcontextroot
The context root for building the preview URL in the toolkit. -
getWebhostport
The host and port for building the preview URL in the toolkit. -
getJavasourcedirectory
The java source directory - where the bean structure editor writes its sources to. -
getWebappaddonsdirectory
Name of the directory in which the webappaddons-files are stored within the project. -
setWebappaddonsdirectory
-
getJavasourcewebinfdirectory
The directory containing the sources that are compiled into WEB-INF/classes. If not explicitly defined then this is either the same asgetJavasourcedirectory()
or this is (if using hot deployment) the same asgetProjectdirectory()
+"/src_webinf". -
getJavaclassdirectory
The directory where the compiled UI classes (managed beans/ backing beans) are located. By default is "webdeployfromdirectory/WEB-INF/classes", but may be explicitly defined. -
setJavaclassdirectory
-
getJavaclasswebinfdirectory
The directory containing the classes that are comiled fromgetJavasourcewebinfdirectory()
. If not explicitly defined then this is either the same asgetJavaclassdirectory()
. In case of using hot deployment the directory is explicitly defined. -
setJavaclasswebinfdirectory
-
getClassPathExtension
Extensions to the class path - semicolon separated list of directories or jar files. -
isCopywebapp
public boolean isCopywebapp()Flag that indicates that a copy of webcontent is executed when executing a reload in the toolkit. -
getCopywebappIgnore
-
getLibrariesForReadAccess
Collection of control libraries. This collection is "passive" in this object, it is NOT filled within the processing of ProjectInfo but serves as container for the Editor tool. -
clearLibraries
public void clearLibraries() -
addLibrary
-
setWebcontentdirectory
for testing purposes only! -
setJavasourcedirectory
for testing purposes only! -
getProjectFileName
-
getJavaSourceEncoding
-
getSupportsHotDeploy
public boolean getSupportsHotDeploy()Flag that indicates that project uses hot deployment of CaptainCasa toolkit. -
getHotDeployFileName
-
getAxis2Home
-
getTemplates
-
getPreviewbgpaint
-
getXml
-
getReloadwebapp
public boolean getReloadwebapp()Flag that indicates that the web application is realoded. The reload is done by sending a reload-URL to the manager application - this is hard-coded for Tomcat... -
getAdditionalResources
-
getCheckForUpdatedFiles
public boolean getCheckForUpdatedFiles() -
getExpressionManager
-
getCommandlinefilenotwriteable
A command line that is executed if the file (e.g. jsp-page) that is written within the CaptainCasa toolkit is read-only. The command line may be a call to the source code versioning system to un-block the corresponding file. -
getUitestcasedirectory
-
getAllowversionupdatebytoolset
public boolean getAllowversionupdatebytoolset()Defines if a version update through the CaptainCasa toolset is allowed or not. Default: true (allowed). You sometimtes do not want the CaptainCasa toolset to update your project because you may use a different project structure than CaptainCasa. -
setAllowversionupdatebytoolset
public void setAllowversionupdatebytoolset(boolean allowversionupdate) -
getPropertyfilesdirectory
Directory in which property files (multi language management) are stored. -
setHtStylePath
-
getHtStylePath
-
setHtPdaStylePath
-
getHtPdaStylePath
-
addProjectReloadListener
-
removeProjectReloadListener
-
addProjectPageLoadListener
-
removeProjectPageLoadListener
-
setCurrentPageName
-
getCurrentPageName
-
setDispatchername
-
getDispatchername
-
getAdditionalManagedBeans
-
addPageBeanCopyInfo
public ProjectInfo.EditorPageBeanComponentInfo addPageBeanCopyInfo(String jspDirectory, String javaPackage) -
addAdditionalResourceInfo
public ProjectInfo.AdditionalResourceInfo addAdditionalResourceInfo(String package1, String name, String expressionprefix) -
addEmbeddedFunctions
-
addManagedBeanInfoDT
-
addTemplateInfo
-
getAdditionalDeployInfos
-
createAdditionalDeployInfo
-
getAllowclean
public boolean getAllowclean()If true then the "clean&deploy" option is active in the layout editor. By default is true. -
setAllowclean
public void setAllowclean(boolean allowclean) -
pageLoaded
This functions is called when a page is shown within the layout editor. The information is distributed to page load listeners so that these might react accordingly. -
reloadProject
-
clear
public void clear() -
setName
-
setProjectdirectory
-
setWebcontentdeployfromdirectory
-
setWebcontentdeploydirectory
-
setWebcontextroot
-
setWebhostport
-
setCopywebapp
-
setReloadwebapp
-
setProjectFileName
-
setJavaSourceEncoding
-
setJavasourcewebinfdirectory
-
setClassPathExtension
-
setLibraries
-
setTemplates
-
setAxis2Home
-
setCopywebappIgnore
-
setPreviewbgpaint
-
setXml
-
setCheckForUpdateFiles
-
setExpressionManager
-
setCommandlinefilenotwriteable
-
setUitestcasedirectory
-
setPropertyfilesdirectory
-
getCodegeneratorMemberprefix
-
setCodegeneratorMemberprefix
-
getCodegeneratorUIClassSuffix
-
setCodegeneratorUIClassSuffix
-
getCodegeneratorIndent
public int getCodegeneratorIndent() -
setCodegeneratorIndent
public void setCodegeneratorIndent(int codegeneratorIndent) -
getCodegeneratorMembervisibility
-
setCodegeneratorMembervisibility
-
setKeepGeneratedIds
public void setKeepGeneratedIds(boolean value) -
getKeepGeneratedIds
public boolean getKeepGeneratedIds() -
getManagedByCCToolSet
public boolean getManagedByCCToolSet() -
setManagedByCCToolSet
public void setManagedByCCToolSet(boolean projectIsManagedByCCToolSet) -
getWebprotocol
-
setWebprotocol
-
getResourcesInWebContent
public boolean getResourcesInWebContent() -
setResourcesInWebContent
public void setResourcesInWebContent(boolean resourcesInWebContent) -
getResourcesInSource
public boolean getResourcesInSource() -
setResourcesInSource
public void setResourcesInSource(boolean resourcesInSource) -
getPbcinfos
-
setPbcinfos
-
getRuntimeServletTempDirectory
-
setRuntimeServletTempDirectory
-
triggerSrcUpdateInEclipse
public void triggerSrcUpdateInEclipse() -
getHotDeploymentPackages
-
getHotDeploymentPackagesExclude
-
readHotDeploymentPackagesCombined
- Returns:
- Hot deployment packages in internal format: the ones excluded are
starting with "!". This is the format that is processed by the
FileManager.updateDirectory(String, String, String[], boolean, org.eclnt.util.log.IObserver)
ignore management.
-
getStyles
- Returns:
- All style variants that are defined within the project directory.
-
getStyleDirectoryName
-
getProjectStyle
- Returns:
- Name of the style that is the default one for the project. The default project stlye is defined in sessionsdefaults.xml, otherwise it is "default".
-
getStyleVariantsForComponent
Find style variants that are defined for a given component within the default style of the project. -
getStyleValues
-
checkIfAttributeIsManagedByStyle
-
getPackageAbbreviations
-
getDeployinfofilename
File that - if defined - is written when deploying through the CaptainCasa toolset. The content of the file is the content of the project definition. As consequence it is possible to pass design time information of the last deployment into the runtime. -
setDeployinfofilename
-
addPackageAbbreviation
-