Package org.eclnt.editor.tools

Class ProjectInfo

java.lang.Object
org.eclnt.editor.tools.ProjectInfo
public class ProjectInfo extends Object
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.

  • Constructor Details

    • ProjectInfo

      public ProjectInfo()

  • Method Details

    • updateCurrentDesignTimeClassLoaders

      public void updateCurrentDesignTimeClassLoaders(ClassLoader cl, ClassLoader independentCl)

    • getEmbeddedFunctions

      public List<ProjectInfo.EmbeddedFunctions> getEmbeddedFunctions()

    • getTextToLiteralIdInfo

      public ProjectInfo.TextToLiteralIdInfo getTextToLiteralIdInfo()

    • getCurrentDesignTimeClassLoader

      public ClassLoader getCurrentDesignTimeClassLoader()

    • getCurrentDesignTimeIndependentClassLoader

      public ClassLoader 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

      public String getName()
      Name of the project - this is the name of the file within the editor/config/projects-directory of the tool web application.

    • getBeanBrowserClassLoader

      public String getBeanBrowserClassLoader()
      Class loader name that is used within the bean browser.

    • setBeanBrowserClassLoader

      public void setBeanBrowserClassLoader(String beanBrowserClassLoader)

    • isProjectfileStoredInProjectDirectory

      public boolean isProjectfileStoredInProjectDirectory()

    • setProjectfileStoredInProjectDirectory

      public void setProjectfileStoredInProjectDirectory(boolean projectfileStoredInProjectDirectory)

    • getDeeplAPIKey

      public String getDeeplAPIKey()
      Deepl API key for automated translations in tools.

    • setDeeplAPIKey

      public void setDeeplAPIKey(String deeplAPIKey)

    • getDeeplTranslationContext

      public String getDeeplTranslationContext()

    • setDeeplTranslationContext

      public void setDeeplTranslationContext(String deeplTranslationContext)

    • getProjectdirectory

      public String getProjectdirectory()
      The main directory of the development project.

    • getWebcontentdirectory

      public String getWebcontentdirectory()
      The directory where web-resources are stored.

    • getWebcontentdeployfromdirectory

      public String getWebcontentdeployfromdirectory()
      The directory which is copied into the runtime when executing a reload in the toolkit. By default is the same is the getWebcontentdirectory().

    • getWebcontentdeploydirectory

      public String getWebcontentdeploydirectory()
      The target directory for copying the web content, when executing a reload in the toolkit.

    • getWebcontextroot

      public String getWebcontextroot()
      The context root for building the preview URL in the toolkit.

    • getWebhostport

      public String getWebhostport()
      The host and port for building the preview URL in the toolkit.

    • getJavasourcedirectory

      public String getJavasourcedirectory()
      The java source directory - where the bean structure editor writes its sources to.

    • getWebappaddonsdirectory

      public String getWebappaddonsdirectory(boolean withDefaulting)
      Name of the directory in which the webappaddons-files are stored within the project.

    • setWebappaddonsdirectory

      public void setWebappaddonsdirectory(String webappaddonsdirectory)

    • getJavasourcewebinfdirectory

      public String getJavasourcewebinfdirectory()
      The directory containing the sources that are compiled into WEB-INF/classes. If not explicitly defined then this is either the same as getJavasourcedirectory() or this is (if using hot deployment) the same as getProjectdirectory()+"/src_webinf".

    • getJavaclassdirectory

      public String 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

      public void setJavaclassdirectory(String javaclassdirectory)

    • getJavaclasswebinfdirectory

      public String getJavaclasswebinfdirectory()
      The directory containing the classes that are comiled from getJavasourcewebinfdirectory(). If not explicitly defined then this is either the same as getJavaclassdirectory(). In case of using hot deployment the directory is explicitly defined.

    • setJavaclasswebinfdirectory

      public void setJavaclasswebinfdirectory(String javaclasswebinfdirectory)

    • getClassPathExtension

      public String 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

      public String[] getCopywebappIgnore()

    • getLibrariesForReadAccess

      public List<ProjectInfo.DesignTimeTLDInfo> 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

      public void addLibrary(ProjectInfo.DesignTimeTLDInfo library)

    • setWebcontentdirectory

      public void setWebcontentdirectory(String webcontentdirectory)
      for testing purposes only!

    • setJavasourcedirectory

      public void setJavasourcedirectory(String javasourcedirectory)
      for testing purposes only!

    • getProjectFileName

      public String getProjectFileName()

    • getJavaSourceEncoding

      public String getJavaSourceEncoding()

    • getSupportsHotDeploy

      public boolean getSupportsHotDeploy()
      Flag that indicates that project uses hot deployment of CaptainCasa toolkit.

    • getHotDeployFileName

      public String getHotDeployFileName()

    • getAxis2Home

      public String getAxis2Home()

    • getTemplates

      public List<ProjectInfo.TemplateInfo> getTemplates()

    • getPreviewbgpaint

      public String getPreviewbgpaint()

    • getXml

      public String 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

      public List<ProjectInfo.AdditionalResourceInfo> getAdditionalResources()

    • getCheckForUpdatedFiles

      public boolean getCheckForUpdatedFiles()

    • getExpressionManager

      public String getExpressionManager()

    • getCommandlinefilenotwriteable

      public String 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

      public String 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

      public String getPropertyfilesdirectory()
      Directory in which property files (multi language management) are stored.

    • setHtStylePath

      public void setHtStylePath(String htStylePath)

    • getHtStylePath

      public String getHtStylePath()

    • setHtPdaStylePath

      public void setHtPdaStylePath(String htPdaStylePath)

    • getHtPdaStylePath

      public String getHtPdaStylePath()

    • addProjectReloadListener

      public void addProjectReloadListener(ProjectInfo.IProjectReloadListener prl)

    • removeProjectReloadListener

      public void removeProjectReloadListener(ProjectInfo.IProjectReloadListener prl)

    • addProjectPageLoadListener

      public void addProjectPageLoadListener(ProjectInfo.IProjectPageLoadListener ppll)

    • removeProjectPageLoadListener

      public void removeProjectPageLoadListener(ProjectInfo.IProjectPageLoadListener ppll)

    • setCurrentPageName

      public void setCurrentPageName(String value)

    • getCurrentPageName

      public String getCurrentPageName()

    • setDispatchername

      public void setDispatchername(String value)

    • getDispatchername

      public String getDispatchername()

    • getAdditionalManagedBeans

      public List<ProjectInfo.ManagedBeanInfoDT> getAdditionalManagedBeans()

    • addPageBeanCopyInfo

      public ProjectInfo.EditorPageBeanComponentInfo addPageBeanCopyInfo(String jspDirectory, String javaPackage)

    • addAdditionalResourceInfo

      public ProjectInfo.AdditionalResourceInfo addAdditionalResourceInfo(String package1, String name, String expressionprefix)

    • addEmbeddedFunctions

      public void addEmbeddedFunctions(String className, boolean errorIfNotAvailable)

    • addManagedBeanInfoDT

      public ProjectInfo.ManagedBeanInfoDT addManagedBeanInfoDT(String name, String className)

    • addTemplateInfo

      public ProjectInfo.TemplateInfo addTemplateInfo(String resource, String image)

    • getAdditionalDeployInfos

      public List<ProjectInfo.AdditionalDeployCopyInfo> getAdditionalDeployInfos()

    • createAdditionalDeployInfo

      public void createAdditionalDeployInfo(String fromdir, String fromzip, String todir, String ignorecsv, boolean ignoreDuringHotDeployment)

    • 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

      public void pageLoaded(String pageName)
      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

      public void reloadProject(Object trigger)

    • clear

      public void clear()

    • setName

      public void setName(String name)

    • setProjectdirectory

      public void setProjectdirectory(String value)

    • setWebcontentdeployfromdirectory

      public void setWebcontentdeployfromdirectory(String webcontentdeployfromdirectory)

    • setWebcontentdeploydirectory

      public void setWebcontentdeploydirectory(String webcontentdeploydirectory)

    • setWebcontextroot

      public void setWebcontextroot(String webcontextroot)

    • setWebhostport

      public void setWebhostport(String webhostport)

    • setCopywebapp

      public void setCopywebapp(String copywebapp)

    • setReloadwebapp

      public void setReloadwebapp(String reloadwebapp)

    • setProjectFileName

      public void setProjectFileName(String projectFileName)

    • setJavaSourceEncoding

      public void setJavaSourceEncoding(String javaSourceEncoding)

    • setJavasourcewebinfdirectory

      public void setJavasourcewebinfdirectory(String javasourcewebinfdirectory)

    • setClassPathExtension

      public void setClassPathExtension(String classPathExtension)

    • setLibraries

      public void setLibraries(List<ProjectInfo.DesignTimeTLDInfo> libraries)

    • setTemplates

      public void setTemplates(List<ProjectInfo.TemplateInfo> templates)

    • setAxis2Home

      public void setAxis2Home(String axis2Home)

    • setCopywebappIgnore

      public void setCopywebappIgnore(String[] copywebappIgnore)

    • setPreviewbgpaint

      public void setPreviewbgpaint(String previewbgpaint)

    • setXml

      public void setXml(String xml)

    • setCheckForUpdateFiles

      public void setCheckForUpdateFiles(String value)

    • setExpressionManager

      public void setExpressionManager(String value)

    • setCommandlinefilenotwriteable

      public void setCommandlinefilenotwriteable(String value)

    • setUitestcasedirectory

      public void setUitestcasedirectory(String value)

    • setPropertyfilesdirectory

      public void setPropertyfilesdirectory(String propertyfilesdirectory)

    • getCodegeneratorMemberprefix

      public String getCodegeneratorMemberprefix()

    • setCodegeneratorMemberprefix

      public void setCodegeneratorMemberprefix(String codegeneratorPropertyprefix)

    • getCodegeneratorUIClassSuffix

      public String getCodegeneratorUIClassSuffix()

    • setCodegeneratorUIClassSuffix

      public void setCodegeneratorUIClassSuffix(String codegeneratorUIClassSuffix)

    • getCodegeneratorIndent

      public int getCodegeneratorIndent()

    • setCodegeneratorIndent

      public void setCodegeneratorIndent(int codegeneratorIndent)

    • getCodegeneratorMembervisibility

      public String getCodegeneratorMembervisibility()

    • setCodegeneratorMembervisibility

      public void setCodegeneratorMembervisibility(String codegeneratorMembervisibility)

    • setKeepGeneratedIds

      public void setKeepGeneratedIds(boolean value)

    • getKeepGeneratedIds

      public boolean getKeepGeneratedIds()

    • getManagedByCCToolSet

      public boolean getManagedByCCToolSet()

    • setManagedByCCToolSet

      public void setManagedByCCToolSet(boolean projectIsManagedByCCToolSet)

    • getWebprotocol

      public String getWebprotocol()

    • setWebprotocol

      public void setWebprotocol(String webprotocol)

    • getResourcesInWebContent

      public boolean getResourcesInWebContent()

    • setResourcesInWebContent

      public void setResourcesInWebContent(boolean resourcesInWebContent)

    • getResourcesInSource

      public boolean getResourcesInSource()

    • setResourcesInSource

      public void setResourcesInSource(boolean resourcesInSource)

    • getPbcinfos

      public List<ProjectInfo.EditorPageBeanComponentInfo> getPbcinfos()

    • setPbcinfos

      public void setPbcinfos(List<ProjectInfo.EditorPageBeanComponentInfo> pbcinfos)

    • getRuntimeServletTempDirectory

      public String getRuntimeServletTempDirectory()

    • setRuntimeServletTempDirectory

      public void setRuntimeServletTempDirectory(String runtimeServletTempDirectory)

    • triggerSrcUpdateInEclipse

      public void triggerSrcUpdateInEclipse()

    • getHotDeploymentPackages

      public List<ProjectInfo.HotDeploymentPackage> getHotDeploymentPackages()

    • getHotDeploymentPackagesExclude

      public List<ProjectInfo.HotDeploymentPackage> getHotDeploymentPackagesExclude()

    • readHotDeploymentPackagesCombined

      public List<ProjectInfo.HotDeploymentPackage> 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

      public List<String> getStyles()
      Returns:
      All style variants that are defined within the project directory.

    • getStyleDirectoryName

      public String getStyleDirectoryName(String styleName)

    • getProjectStyle

      public String 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

      public List<String> getStyleVariantsForComponent(String componentName)
      Find style variants that are defined for a given component within the default style of the project.

    • getStyleValues

      public List<StyleManager.StyleValue> getStyleValues()

    • checkIfAttributeIsManagedByStyle

      public boolean checkIfAttributeIsManagedByStyle(String componentName, String attributeName, String stylevariantName)

    • getPackageAbbreviations

      public List<ProjectInfo.PackageAbbreviation> getPackageAbbreviations()

    • getDeployinfofilename

      public String 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

      public void setDeployinfofilename(String deployinfofilename)

    • addPackageAbbreviation

      public void addPackageAbbreviation(String packageName, String abbreviation)

    • getBcigenResourcePath

      public String getBcigenResourcePath()
      Resource path that is used inside RapidApp for storing data that is accessed with class loader context.

    • getBcigenResourceDirectory

      public String getBcigenResourceDirectory()
      Resource base directory for resources that are used inside RapidApp for storing data that is accessed with class loader context.