| Home >> All >> com >> RuntimeCollective >> [ content Javadoc ] |
• com.RuntimeCollective.content: Javadoc index of package com.RuntimeCollective.content.
Package Samples:
• com.RuntimeCollective.content.bean: The Content module defines the Content contract for the Josephine framework, as well as a collection of basic types of Content (TextComponent, File, Image).
• com.RuntimeCollective.content.action
• com.RuntimeCollective.content.form
• com.RuntimeCollective.content.servlet
• com.RuntimeCollective.content.tag
• com.RuntimeCollective.content.test
Classes:
• EditorCheckLogonTag: Check for a valid User logged on in the current session under the key RuntimeParameters.get("logonUserKey") . If there is no such user, check for a cookie called "LoginCookie.COOKIE_NAME"; the random-key contained in this cookie will reference rs_user , to give the userId. If no such cookie exists, forward control to the logon page. This class has some logic which could be moved to CheckLogonTag Important: This tag must be placed on a jsp page before anything is written to the response. It's safest to always put it at the top. If the user is found from a cookie, a new Session is recorded by calling ...
• ForwardLink: The ForwardLink class implements the Link abstract class, using a URL. For now, we cannot directly access the forwards defined in struts-config.xml. So all forwards used for ForwardLinks have to be copied into web.xml, as a param.FORWARDforwardname parameter. Sorry for the inconvenience. HOW TO : add a new Static Link ------------------------------ Step 1 - creating in the database a new ForwardLink. See /se/datamodel/mssqlserver/Content-sedata-load.sql for examples. Just copy an example, and change the name of the struts Forward you will be using, and its display name. Step 2 - in struts-config.xml, ...
• Link: The Link abstract class describes a Link entity, obviously. To implement a new kind of Link, you will have to define: - isDisplayable: says whether the Link is ready to be displayed - getLinkURL: gives a URL representation of this Link The bias here is for HTML links: viewFormat by default only supports the following formats: - "html", - "htmlshort", where LinkText is replaced by the URL - "htmlurl", as above and the ExplanatoryText is not shown (This is why getLinkURL has to be defined). You can extend viewFormat to support any other format you want. Existing implementations include at this time: ...
• URLLink: The URLLink class implements the Link abstract class, using a URL. Some refer to this class as ExternalLink. If you want to be spared the hassle of writing JSPs for the editing of your URLLink objects, do have a look at the pages written for the Sussex Enterprise project. You can find them by checking out the relevent project: "cvs co rsework", then look in rsework/web/admin. The pages are called create/edit/deleteExternalLinkXXX.jsp. They should be pretty self-explanatory. The rsework/struts-config.xml file is also worth checking, for the action mappings etc. And while you're at it, why not vanilla ...
• File: The File class will hold the content of a file, either directly, or via a filename reference. In the first case, the content will be saved in the permanence layer (e.g. database), in the other, only the reference to the file will be kept. If the latter, then the following runtime parameters must be set: contentFilesDataDir -- The directory where the content files will be stored. pageRoot -- The page root of the application contentFilesUrlStub -- The url path, relative to the application page root, where the content files will be available.
• EditorAttributesTag: Evaluate the nested body content of this tag if the logged-on user (on the session under RuntimeParameters.get("logonUserKey") ) has some combination of attributes set (isAdmin, isEditor). Parameters are: isAdmin - will only evaluate body contents if the user is an administrator. isEditor - will only evaluate body contents if the user is a content editor (or administrator). isNotAdmin - will only evaluate body contents if the user is not an administrator. isNotEditor - will only evaluate body contents if the user is not a content editor (or administrator).
• FileServlet: Serves Files, based on the request URL. The URL should be of the form: http://www.myServer.com/url-pattern/1234.pdf where url-pattern is mapped in web.xml , 1234 is the File id, and .pdf is the file type of the File. The (possibly) returned file will be: contentFilesDataDir/1234.pdf where contentFileDir is defined in web.xml . Note: the "image/vnd.rn-realflash" mime type is replaced with "application/x-shockwave-flash".
• DublinCore: An interface that allows access to Dublin Core v1-1 metadata stored in the implementing object. This is a read only interface which should be implemented if you want to allow the Dublin Core metadata for your object to be implemented in a text format such as XML. Note: all methods in this interface should return Strings or vectors of Strings.
• Thumbnail: The Thumbnail class contains static methods to create a Thumbnail from an Image. It relies on the thumbnailQuality RuntimeParameter to be set; this should be a number between 0 and 100, corresponding to JPEG encoding quality for the resultant thumbnail. It borrows heavily from http://www.geocities.com/marcoschmidt.geo/java-save-jpeg-thumbnail.html - thanks, Marco!
• ViewContentFormatTag: A custom JSP tag that displays a Content in a given format: name - the name of the Publishable bean (on any scope). property - the property of the named bean that holds the bean to publish [Optional] . format - the format required.
• TextComponent: This class is a basic Content holding a piece of text. It doesn't have a title nor a description: those are inferred from the text. TextComponent can be used as is to store eg news items. Alternatively, it can be composed by a more complex Content, such as a website's Page, or a nice Article.
• Image: The Image class contains a reference to a File, and some metadata (for now a simple caption). There are now two ways to use Images - the normal way, or with the ImageLibrary. delete and duplicate behave differently in each case.
• VersionedExtensionTest: Test class for VersionedExtension. This is in content as we use SimpleContent as a test Duplicable. FIXME: make some duplicable bean in webapps, and move this test there. $Id: VersionedExtensionTest.java,v 1.3 2003/09/30 15:12:47 joe Exp $
• NoteForm: A form to link a new Note (TextComponent) to a given EntityBean. This uses the role given, and links from the annoted bean to the note. Works hands in hands with NoteAction.
• NewContentTest: This is the Content test methods, configured in the new way. It requires several sysproperties: contentFilesDataDir, contentFilesUrlStub, pageRoot.
• NewVersionTest: This is the Version test methods, configured in the new way. It requires several sysproperties: contentFilesDataDir, contentFilesUrlStub, pageRoot.
• SwitchEditorRoleAction: Implementation of Action that sets on or off the Editor Role of a User. Id of the user should be passed as a parameter.
• Content: Interface to implement if you want an object to be considerable as a piece of content. Typical subclasses: TextComponent, Image.
• ContentException: The subclass of RuntimeException which should be thrown by classes in the Content module when they meet some kind of problem.
• NoteAction: An action which adds a Note to a bean, by linking a new TextComponent from the bean under a given role.
• ContentForm: Represents the information stored in a bit of Content. By default, no validation is performed.
• ContentTestMethods: The methods for the ContestTest, which are used by both the old style and new style test script.
• FileForm: Represents the information stored in a File. By default, no validation is performed.
• SimpleContent: A basic implementation of Content, which you shouldn't instantiate as is, but subclass.
• Editor: Represents a user of the content module who has editor or administrator permissions.
| Home | Contact Us | Privacy Policy | Terms of Service |