Home >> All >> com >> opencms >> [ defaults Javadoc ]

•

com.opencms.defaults.master.* (8)

•

com.opencms.defaults.master.genericsql.* (1)

• com.opencms.defaults: Javadoc index of package com.opencms.defaults.


Package Samples:

• com.opencms.defaults.master.genericsql: The "master module", an extendable content definition that uses a standard file table in the DB.  
• com.opencms.defaults.master: Provides often needed functionality for OpenCms, like building a navigation or sending mails.  

Classes:

• CmsShowContent: Generic class for showing information encapsulated by contentdefinition objects. There are mainly two user methods in this template class for this purpose: getEntry and getList. The getEntry method accepts an id or read it from the url parameters (it has to be named id to be found) if given and set datablocks inside the template with values returned by all public get-methods of the contentdefinition that returns a String and have no parameters. This method must be called in the template before acccessing any of this data with process tags. The getList method builds a list of contentdefinition entries. ...
• CmsMail: This class is used to send a mail using the JavaMail package. Sun's mail.jar and activation.jar are required, if this class should be used in any OpenCms class. Sender and recipients addresses may be given as String or as CmsUser objects. Different constructors for setting additional CC and BCC addresses are provided. Attachments can be added using the addAttachment() method. If the current HTTP request is a multipart/form-data request and contains uploaded files, all these files will be sent as attachments, too. For performance reasons, this classes uses threads for sending mails. Mail threads ...
• A_CmsBackoffice: Abstract class for generic backoffice display. It automatically generates the head section with filters and buttons, body section with the table data, lock states of the entries. if there are any, delete dialog, lock dialog. calls the edit dialog of the calling backoffice class new dialog of the calling backoffice class using the content definition class defined by the getContentDefinition method. The methods and data provided by the content definition class is accessed by reflection. This way it is possible to re-use this class for any content definition class, that just has to extend the A_CmsContentDefinition ...
• I_CmsTimedContentDefinition: Content Definitions that uses the timing, that means the cd can define a timeinterval in which the content is valid. The publicationDate is the begin of the timeinterval and the purgeDate is the end. If this interface is used the method isTimedContent() should return true.
• CmsXmlFormTemplateFile: Template content definition for generating HTML forms. This is an extension of the default template content definition. Special tags for handling HTML form elements are added here. See the handleXxxTag Methods for more details.
• CmsChannelContent: This class is the master of several Modules. It carries a lot of generic data-fileds which can be used for a special Module. The module creates a set of methods to support project-integration, history and import - export.
• CmsMasterContent: This class is the master of several Modules. It carries a lot of generic data-fileds which can be used for a special Module. The module creates a set of methods to support project-integration, history and import - export.
• CmsXmlFormTemplate: Common template class for displaying OpenCms workplace screens. Reads template files of the content type CmsXmlWpTemplateFile . Most special workplace classes may extend this class.
• CmsMasterDataSet: This class defines the dataset of the master module. It carries a lot of generic data-fileds which can be used for a special Module. This class should only be used within this mastermodule.
• I_CmsExtendedContentDefinition: Content Definitions that uses the projectmanagement, that means the cd can be published and the history can be enabled, should implement this interface
• CmsMasterMedia: An instance of this module describes a modulemedia entry in the database. It carries a set of data to read and write.
• I_CmsLifeCycle: Defines methods to start-up and shut-down module classes that are registerd in the OpenCms registry.
• A_CmsContentDefinition: Abstract class for the content definition Creation date: (27.10.00 10:04:42)
• CmsFilterMethod: Insert the type's description here. Creation date: (08.11.00 12:02:57)
• CmsDbAccess: This class provides methods to access the database in a generic way.
• A_CmsNavBase: This abstract class builds the default Navigation.
• CmsShowBackofficeMedia: Displays binary files attached to module data.
• A_CmsChannelBackoffice: Backoffice class with channel functionality
• CmsXmlNav: This class builds the default Navigation.
• CmsShowMedia: XmlTemplate class to show media objects
• CmsChannelBackoffice

Home | Contact Us | Privacy Policy | Terms of Service