Menu
▾
▴
[Aplaws-commit] r2472 - in trunk: . ccm-cms-types-agenda/src/com/arsdigita/cms/contenttypes ccm-cms-types-article/src/com/arsdigita/cms/contenttypes ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ui ccm-cms-types-bookmark/src/com/arsdigita/cms/contenttypes ccm-cms-types-event/src/com/arsdigita/cms/contenttypes ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util ccm-cms-types-faqitem/src/com/arsdigita/cms/contenttypes ccm-core/src ccm-core/src/com/arsdigita/toolbox/ui ccm-ldn-types-contact/src/com/arsdigita/london/contenttypes ccm-navigation/src/com/arsdigita/navigation
Author: pboy
Date: 2013-02-02 18:43:41 +0000 (Sat, 02 Feb 2013)
New Revision: 2472
Modified:
trunk/
trunk/ccm-cms-types-agenda/src/com/arsdigita/cms/contenttypes/AgendaLoader.java
trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ArticleLoader.java
trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ui/ArticlePropertiesStep.java
trunk/ccm-cms-types-bookmark/src/com/arsdigita/cms/contenttypes/BookmarkLoader.java
trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/EventLoader.java
trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertiesStep.java
trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertyForm.java
trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventGlobalizationUtil.java
trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventResourceBundle.java
trunk/ccm-cms-types-faqitem/src/com/arsdigita/cms/contenttypes/FAQItemLoader.java
trunk/ccm-core/src/ccm-core.checklist
trunk/ccm-core/src/ccm-core.load
trunk/ccm-core/src/ccm-core.upgrade
trunk/ccm-core/src/com/arsdigita/toolbox/ui/DomainObjectPropertySheet.java
trunk/ccm-ldn-types-contact/src/com/arsdigita/london/contenttypes/ContactLoader.java
trunk/ccm-navigation/src/com/arsdigita/navigation/Loader.java
Log:
Enhanced various formatting, added various documentation.
Property changes on: trunk
___________________________________________________________________
Modified: svn:ignore
- conf
runtime
build-projects.xml
local.**.properties
build.xml
packages
nbproject
Project**
.ant-targets-build.xml
.local.ccm.properties.swp
.tmp.project.xml
.tmp.applications.list
.tmp.applications.list.swp
.local.runtime.properties.swp
.local.build.properties.swp
ccm-lbc-**
+ conf
runtime
build-projects.xml
local.**.properties
build.xml
packages
nbproject
Project**
.ant-targets-build.xml
.local.ccm.properties.swp
.tmp.project.xml
.tmp.applications.list
.tmp.applications.list.swp
.local.runtime.properties.swp
.local.build.properties.swp
ccm-lbc-**
.r2449.msg.swp
Modified: trunk/ccm-cms-types-agenda/src/com/arsdigita/cms/contenttypes/AgendaLoader.java
===================================================================
--- trunk/ccm-cms-types-agenda/src/com/arsdigita/cms/contenttypes/AgendaLoader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-agenda/src/com/arsdigita/cms/contenttypes/AgendaLoader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,18 +21,33 @@
import com.arsdigita.cms.contenttypes.AbstractContentTypeLoader;
/**
- * Loader. Just sets content type specific properties for use of the parent class.
+ * Loader executes nonrecurring once at install time and loads the Agenda
+ * contenttype package persistently into database.
*
+ * It uses the base class to create the database schema and the required
+ * table entries for the contenttype.
+ *
* @author Rafael H. Schloming <rh...@mi...>
* @version $Revision: #7 $ $Date: 2004/08/17 $
* @version $Id$
*/
public class AgendaLoader extends AbstractContentTypeLoader {
+ /** Defines the xml file containing the EForm content types property
+ * definitions. */
private static final String[] TYPES = {
"/WEB-INF/content-types/com/arsdigita/cms/contenttypes/Agenda.xml"
};
+ /**
+ * Provides the of Agenda contenttype property definitions implementing
+ * the parent's class abstract method.
+ *
+ * The file defines the types name as displayed in content center
+ * select box and the authoring steps. These are loaded into database.
+ *
+ * @return String Array of fully qualified file names
+ */
public String[] getTypes() {
return TYPES;
}
Modified: trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ArticleLoader.java
===================================================================
--- trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ArticleLoader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ArticleLoader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,17 +21,32 @@
// import com.arsdigita.cms.contenttypes.AbstractContentTypeLoader;
/**
- * Loader.
+ * Loader executes nonrecurring once at install time and loads the Article
+ * contenttype package persistently into database.
*
+ * It uses the base class to create the database schema and the required
+ * table entries for the contenttype.
+ *
* @author Justin Ross <jr...@re...>
* @version $Id$
*/
public class ArticleLoader extends AbstractContentTypeLoader {
+ /** Defines the xml file containing the Article content types property
+ * definitions. */
private static final String[] TYPES = {
"/WEB-INF/content-types/com/arsdigita/cms/contenttypes/Article.xml"
};
+ /**
+ * Provides the of Article contenttype property definitions
+ * implementing the parent's class abstract method.
+ *
+ * The file defines the types name as displayed in content center
+ * select box and the authoring steps. These are loaded into database.
+ *
+ * @return String Atring Array of fully qualified file names
+ */
public String[] getTypes() {
return TYPES;
}
Modified: trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ui/ArticlePropertiesStep.java
===================================================================
--- trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ui/ArticlePropertiesStep.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-article/src/com/arsdigita/cms/contenttypes/ui/ArticlePropertiesStep.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,11 +21,11 @@
import com.arsdigita.bebop.Component;
import com.arsdigita.cms.ItemSelectionModel;
import com.arsdigita.cms.contenttypes.Article;
-import com.arsdigita.toolbox.ui.DomainObjectPropertySheet;
import com.arsdigita.cms.ui.authoring.AuthoringKitWizard;
import com.arsdigita.cms.ui.authoring.BasicPageForm;
import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
import com.arsdigita.cms.util.GlobalizationUtil;
+import com.arsdigita.toolbox.ui.DomainObjectPropertySheet;
/**
* Authoring step to edit the simple attributes of the Article content
Modified: trunk/ccm-cms-types-bookmark/src/com/arsdigita/cms/contenttypes/BookmarkLoader.java
===================================================================
--- trunk/ccm-cms-types-bookmark/src/com/arsdigita/cms/contenttypes/BookmarkLoader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-bookmark/src/com/arsdigita/cms/contenttypes/BookmarkLoader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,17 +21,32 @@
import com.arsdigita.cms.contenttypes.AbstractContentTypeLoader;
/**
- * Loader.
+ * Loader executes nonrecurring once at install time and loads the
+ * Bookmark contenttype package persistently into database.
*
+ * It uses the base class to create the database schema and the required
+ * table entries for the contenttype.
+ *
* @author Justin Ross <jr...@re...>
* @version $Id$
*/
public class BookmarkLoader extends AbstractContentTypeLoader {
- private static final String[] TYPES = {
+ /** Defines the xml file containing the Bookmark content types
+ * property definitions. */
+ private static final String[] TYPES = {
"/WEB-INF/content-types/com/arsdigita/cms/contenttypes/Bookmark.xml"
};
+ /**
+ * Provides the of Bookmark contenttype property definitions implementing
+ * the parent's class abstract method.
+ *
+ * The file defines the types name as displayed in content center
+ * select box and the authoring steps. These are loaded into database.
+ *
+ * @return String Atring Array of fully qualified file names
+ */
public String[] getTypes() {
return TYPES;
}
Modified: trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/EventLoader.java
===================================================================
--- trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/EventLoader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/EventLoader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,19 +21,33 @@
import com.arsdigita.cms.contenttypes.AbstractContentTypeLoader;
/**
- * Loader
+ * Loader executes nonrecurring once at install time and loads the
+ * Event contenttype package persistently into database.
*
+ * It uses the base class to create the database schema and the required
+ * table entries for the contenttype.
+ *
* @author Rafael H. Schloming <rh...@mi...>
* @version $Revision: #6 $ $Date: 2004/08/17 $
* @version $Id$
- **/
-
+ */
public class EventLoader extends AbstractContentTypeLoader {
- private static final String[] TYPES = {
+ /** Defines the xml file containing the EForm content types
+ * property definitions. */
+private static final String[] TYPES = {
"/WEB-INF/content-types/com/arsdigita/cms/contenttypes/Event.xml"
};
+ /**
+ * Provides the of Event contenttype property definitions
+ * implementing the parent's class abstract method.
+ *
+ * The file defines the types name as displayed in content center
+ * select box and the authoring steps. These are loaded into database.
+ *
+ * @return String Atring Array of fully qualified file names
+ */
public String[] getTypes() {
return TYPES;
}
Modified: trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertiesStep.java
===================================================================
--- trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertiesStep.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertiesStep.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -24,14 +24,14 @@
import com.arsdigita.cms.ContentSection;
import com.arsdigita.cms.ItemSelectionModel;
import com.arsdigita.cms.contenttypes.Event;
-import com.arsdigita.domain.DomainObject;
-import com.arsdigita.toolbox.ui.DomainObjectPropertySheet;
+import com.arsdigita.cms.contenttypes.util.EventGlobalizationUtil;
import com.arsdigita.cms.ui.authoring.AuthoringKitWizard;
import com.arsdigita.cms.ui.authoring.BasicPageForm;
import com.arsdigita.cms.ui.authoring.SimpleEditStep;
import com.arsdigita.cms.ui.workflow.WorkflowLockedComponentAccess;
-import com.arsdigita.cms.contenttypes.util.EventGlobalizationUtil;
+import com.arsdigita.domain.DomainObject;
import com.arsdigita.globalization.GlobalizationHelper;
+import com.arsdigita.toolbox.ui.DomainObjectPropertySheet;
import java.text.DateFormat;
import java.util.Calendar;
@@ -39,26 +39,36 @@
/**
* Authoring step to view/edit the simple attributes of the Event content type (and
- * its subclasses). The attributes edited are 'name', 'title', 'lead',
+ * its subclasses).
+ *
+ * The attributes edited are 'name', 'title', 'lead',
* 'start date', 'starttime', end date', 'end time','event date' (literal descr. of date),
* 'location', 'main contributor', 'event type', 'map link', and
- * 'cost'. This authoring step replaces the
+ * 'cost'.
+ *
+ * This authoring step replaces the
* <code>com.arsdigita.ui.authoring.PageEdit</code> step for this type.
- **/
+ */
public class EventPropertiesStep extends SimpleEditStep {
/** The name of the editing sheet added to this step */
public static String EDIT_SHEET_NAME = "edit";
+ /**
+ *
+ * @param itemModel
+ * @param parent
+ */
public EventPropertiesStep(ItemSelectionModel itemModel,
- AuthoringKitWizard parent) {
+ AuthoringKitWizard parent) {
super(itemModel, parent);
setDefaultEditKey(EDIT_SHEET_NAME);
BasicPageForm editSheet;
editSheet = new EventPropertyForm(itemModel, this);
- add(EDIT_SHEET_NAME, "Edit", new WorkflowLockedComponentAccess(editSheet, itemModel),
+ add(EDIT_SHEET_NAME, "Edit",
+ new WorkflowLockedComponentAccess(editSheet, itemModel),
editSheet.getSaveCancelSection().getCancelButton());
setDisplayComponent(getEventPropertySheet(itemModel));
@@ -76,9 +86,14 @@
public static Component getEventPropertySheet(ItemSelectionModel itemModel) {
DomainObjectPropertySheet sheet = new DomainObjectPropertySheet(itemModel);
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.name").localize(), Event.NAME);
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.title").localize(), Event.TITLE);
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.lead").localize(), Event.LEAD);
+
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.name").localize(), Event.NAME);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.title").localize(), Event.TITLE);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.lead").localize(), Event.LEAD);
+
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.name"), Event.NAME);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.title"), Event.TITLE);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.lead"), Event.LEAD);
if (!ContentSection.getConfig().getHideLaunchDate()) {
sheet.add(EventGlobalizationUtil.globalize("cms.contenttypes.ui.launch_date"),
ContentPage.LAUNCH_DATE,
@@ -96,8 +111,9 @@
}
});
}
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_time").localize(), Event.START_DATE,
- new DomainObjectPropertySheet.AttributeFormatter() {
+// sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_time").localize(), Event.START_DATE,
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_time"), Event.START_DATE,
+ new DomainObjectPropertySheet.AttributeFormatter() {
public String format(DomainObject item,
String attribute,
@@ -121,7 +137,8 @@
}
});
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.end_time").localize(), Event.END_DATE,
+// sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.end_time").localize(), Event.END_DATE,
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.end_time"), Event.END_DATE,
new DomainObjectPropertySheet.AttributeFormatter() {
public String format(DomainObject item,
@@ -145,21 +162,27 @@
}
});
if (!Event.getConfig().getHideDateDescription()) {
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.date_description").localize(), Event.EVENT_DATE);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.date_description").localize(), Event.EVENT_DATE);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.date_description"), Event.EVENT_DATE);
}
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.location").localize(), Event.LOCATION);
+// sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.location").localize(), Event.LOCATION);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.location"), Event.LOCATION);
if (!Event.getConfig().getHideMainContributor()) {
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.main_contributor").localize(), Event.MAIN_CONTRIBUTOR);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.main_contributor").localize(), Event.MAIN_CONTRIBUTOR);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.main_contributor"), Event.MAIN_CONTRIBUTOR);
}
if (!Event.getConfig().getHideEventType()) {
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.event_type").localize(), Event.EVENT_TYPE);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.event_type").localize(), Event.EVENT_TYPE);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.event_type"), Event.EVENT_TYPE);
}
if (!Event.getConfig().getHideLinkToMap()) {
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.link_to_map").localize(), Event.MAP_LINK);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.link_to_map").localize(), Event.MAP_LINK);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.link_to_map"), Event.MAP_LINK );
}
if (!Event.getConfig().getHideCost()) {
- sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.cost").localize(), Event.COST);
+ // sheet.add((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.cost").localize(), Event.COST);
+ sheet.add( EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.cost"), Event.COST );
}
return sheet;
}
Modified: trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertyForm.java
===================================================================
--- trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertyForm.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/ui/EventPropertyForm.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -30,22 +30,24 @@
import com.arsdigita.bebop.form.Time;
import com.arsdigita.bebop.parameters.DateParameter;
import com.arsdigita.bebop.parameters.NotNullValidationListener;
+import com.arsdigita.bebop.parameters.ParameterModel;
import com.arsdigita.bebop.parameters.StringInRangeValidationListener;
-import com.arsdigita.bebop.parameters.ParameterModel;
import com.arsdigita.bebop.parameters.StringParameter;
import com.arsdigita.bebop.parameters.TimeParameter;
import com.arsdigita.bebop.parameters.TrimmedStringParameter;
import com.arsdigita.cms.ItemSelectionModel;
import com.arsdigita.cms.contenttypes.Event;
-import com.arsdigita.cms.ui.authoring.BasicPageForm;
import com.arsdigita.cms.contenttypes.util.EventGlobalizationUtil;
import com.arsdigita.cms.ui.CMSDHTMLEditor;
+import com.arsdigita.cms.ui.authoring.BasicPageForm;
+
import java.util.Calendar;
import java.util.GregorianCalendar;
/**
- * Form to edit the basic properties of an <code>Event</code> object. Used by
- * <code>EventPropertiesStep</code> authoring kit step.
+ * Form to edit the basic properties of an <code>Event</code> object.
+ *
+ * Used by <code>EventPropertiesStep</code> authoring kit step.
* <br />
* This form can be extended to create forms for Event subclasses.
**/
@@ -113,7 +115,7 @@
super.addWidgets();
/* Summary (lead) */
- add(new Label((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.lead").localize()));
+ add(new Label(EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.lead")) );
ParameterModel leadParam = new StringParameter(LEAD);
if(Event.getConfig().isLeadTextOptional()) {
leadParam.addParameterListener(new NotNullValidationListener());
@@ -124,7 +126,7 @@
add(lead);
/* Start date and time */
ParameterModel eventStartDateParam = new DateParameter(START_DATE);
- add(new Label((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_date").localize()));
+ add(new Label(EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_date")) );
eventStartDateParam.addParameterListener(new NotNullValidationListener());
// Use bebop date instead of java.util.date
m_startDate = new com.arsdigita.bebop.form.Date(eventStartDateParam);
@@ -134,7 +136,7 @@
add(m_startDate);
ParameterModel eventStartTimeParam = new TimeParameter(START_TIME);
- add(new Label((String) EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_time").localize()));
+ add(new Label(EventGlobalizationUtil.globalize("cms.contenttypes.ui.event.start_time")) );
if(Event.getConfig().isStartTimeOptional()) {
eventStartTimeParam.addParameterListener(new NotNullValidationListener());
}
Modified: trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventGlobalizationUtil.java
===================================================================
--- trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventGlobalizationUtil.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventGlobalizationUtil.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -16,10 +16,12 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
+
package com.arsdigita.cms.contenttypes.util;
import com.arsdigita.globalization.GlobalizedMessage;
+
/**
* <p>
* Contains methods to simplify globalizing keys
@@ -28,9 +30,9 @@
* @author <a href="mailto:ra...@ar...">ra...@ar...</a>
* @version $Revision: #4 $ $Date: 2004/08/17 $
*/
-
public class EventGlobalizationUtil {
+ /** Name of the Java class to handle Event's globalisation. */
final public static String BUNDLE_NAME =
"com.arsdigita.cms.contenttypes.util.EventResourceBundle";
Modified: trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventResourceBundle.java
===================================================================
--- trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventResourceBundle.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-event/src/com/arsdigita/cms/contenttypes/util/EventResourceBundle.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -18,17 +18,18 @@
*/
package com.arsdigita.cms.contenttypes.util;
-import java.util.PropertyResourceBundle;
+import com.arsdigita.cms.CMSGlobalized;
import com.arsdigita.globalization.ChainedResourceBundle;
-import com.arsdigita.cms.CMSGlobalized;
+import java.util.PropertyResourceBundle;
+
/**
* Resource Bundle used in UI for Event ContentType.
*
- * @author Shashin Shinde <a href="mailto:ss...@re...">ss...@re...</a>
- *
+ * @author Shashin Shinde (ss...@re...)
*/
-public class EventResourceBundle extends ChainedResourceBundle implements CMSGlobalized {
+public class EventResourceBundle extends ChainedResourceBundle
+ implements CMSGlobalized {
public final static String EVENT_BUNDLE_NAME =
"com.arsdigita.cms.contenttypes.EventResources";
Modified: trunk/ccm-cms-types-faqitem/src/com/arsdigita/cms/contenttypes/FAQItemLoader.java
===================================================================
--- trunk/ccm-cms-types-faqitem/src/com/arsdigita/cms/contenttypes/FAQItemLoader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-cms-types-faqitem/src/com/arsdigita/cms/contenttypes/FAQItemLoader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,17 +21,32 @@
import com.arsdigita.cms.contenttypes.AbstractContentTypeLoader;
/**
- * Loader.
+ * Loader executes nonrecurring once at install time and loads the
+ * FAQ contenttype package persistently into database.
*
+ * It uses the base class to create the database schema and the required
+ * table entries for the contenttype.
+ *
* @author Justin Ross <jr...@re...>
* @version $Id$
*/
public class FAQItemLoader extends AbstractContentTypeLoader {
+ /** Defines the xml file containing the FAQ content types
+ * property definitions. */
private static final String[] TYPES = {
"/WEB-INF/content-types/com/arsdigita/cms/contenttypes/FAQItem.xml"
};
+ /**
+ * Provides the of FAQ contenttype property definitions
+ * implementing the parent's class abstract method.
+ *
+ * The file defines the types name as displayed in content center
+ * select box and the authoring steps. These are loaded into database.
+ *
+ * @return String Atring Array of fully qualified file names
+ */
public String[] getTypes() {
return TYPES;
}
Modified: trunk/ccm-core/src/ccm-core.checklist
===================================================================
--- trunk/ccm-core/src/ccm-core.checklist 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-core/src/ccm-core.checklist 2013-02-02 18:43:41 UTC (rev 2472)
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
<!-- Specification file for additional checks during the
installation process by the packaging tools
(see com/arsdigita/packaging/Check.java for details) -->
Modified: trunk/ccm-core/src/ccm-core.load
===================================================================
--- trunk/ccm-core/src/ccm-core.load 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-core/src/ccm-core.load 2013-02-02 18:43:41 UTC (rev 2472)
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
<load>
<provides>
<table name="inits"/>
Modified: trunk/ccm-core/src/ccm-core.upgrade
===================================================================
--- trunk/ccm-core/src/ccm-core.upgrade 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-core/src/ccm-core.upgrade 2013-02-02 18:43:41 UTC (rev 2472)
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
<upgrade>
<version from="6.0.0" to="6.0.1">
<script sql="ccm-core/upgrade/::database::-6.0.0-6.0.1.sql"/>
Modified: trunk/ccm-core/src/com/arsdigita/toolbox/ui/DomainObjectPropertySheet.java
===================================================================
--- trunk/ccm-core/src/com/arsdigita/toolbox/ui/DomainObjectPropertySheet.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-core/src/com/arsdigita/toolbox/ui/DomainObjectPropertySheet.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -22,29 +22,28 @@
import com.arsdigita.bebop.PropertySheet;
import com.arsdigita.bebop.PropertySheetModel;
import com.arsdigita.bebop.PropertySheetModelBuilder;
+import com.arsdigita.domain.DomainObject;
+import com.arsdigita.domain.DomainService;
+import com.arsdigita.globalization.GlobalizedMessage;
+import com.arsdigita.kernel.ui.DomainObjectSelectionModel;
+import com.arsdigita.persistence.DataObject;
+import com.arsdigita.toolbox.util.GlobalizationUtil;
import com.arsdigita.util.LockableImpl;
-import java.util.List;
-import java.util.LinkedList;
import java.util.Iterator;
+import java.util.LinkedList;
+import java.util.List;
import java.util.StringTokenizer;
-import com.arsdigita.domain.DomainService;
-import com.arsdigita.domain.DomainObject;
-import com.arsdigita.persistence.DataObject;
-import com.arsdigita.kernel.ui.DomainObjectSelectionModel;
-import com.arsdigita.globalization.GlobalizedMessage;
-import com.arsdigita.toolbox.util.GlobalizationUtil;
-
-
/**
* Displays a list of label-value pairs, which represent the attributes
* of a domain object.
* <p>
* Typical usage is
* <blockquote><pre><code>
- * DomainObjectPropertySheet mySheet = new DomainObjectPropertySheet(myDomainObjectSelectionModel);
+ * DomainObjectPropertySheet mySheet =
+ * new DomainObjectPropertySheet(myDomainObjectSelectionModel);
* mySheet.add("Name:", ContentPage.NAME);
* mySheet.add("Title:", ContentPage.TITLE);
* </code></pre></blockquote>
@@ -65,9 +64,9 @@
* Note that, by default, <code>DomainObjectPropertySheet</code> retrieves
* the values for its properties directly from the underlying {@link DataObject}
* of the {@link DomainObject}. This means that the Java <code>getXXX</code>
- * methods of the <code>DomainObject</code> will never be called. Of course, it
- * is always possible to create a custom {@link AttributeFormatter} that will call the
- * appropriate methods.
+ * methods of the <code>DomainObject</code> will never be called. Of course,
+ * it is always possible to create a custom {@link AttributeFormatter} that
+ * will call the appropriate methods.
*
* @author Stanislav Freidin
* @version $Id$
@@ -75,8 +74,6 @@
*/
public class DomainObjectPropertySheet extends PropertySheet {
- public static final String versionId =
- "$Id$ by $Author$, $DateTime: 2004/08/16 18:10:38 $";
private List m_props;
private DomainObjectSelectionModel m_objModel;
private AttributeFormatter m_toStringFormatter;
@@ -157,7 +154,8 @@
* @param label The label for the attribute
* @param attribute The name for the attribute
* @param formatter An instance of AttributeFormatter
- * @deprecated Use add(GlobalizedMessage label, String attribute, AttributeFormatter f) instead
+ * @deprecated Use add(GlobalizedMessage label, String attribute,
+ * AttributeFormatter f) instead
*/
public void add(String label, String attribute, AttributeFormatter f) {
add(GlobalizationUtil.globalize(label), attribute, f);
@@ -252,7 +250,7 @@
private Iterator m_props;
private Property m_current;
private static String ERROR =
- "No current property. Make sure that nextRow() was called at least once.";
+ "No current property. Make sure that nextRow() was called at least once.";
public DomainObjectPropertiesModel(
DomainObject obj, Iterator props, PageState state) {
Modified: trunk/ccm-ldn-types-contact/src/com/arsdigita/london/contenttypes/ContactLoader.java
===================================================================
--- trunk/ccm-ldn-types-contact/src/com/arsdigita/london/contenttypes/ContactLoader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-ldn-types-contact/src/com/arsdigita/london/contenttypes/ContactLoader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -33,13 +33,21 @@
*/
public class ContactLoader extends AbstractContentTypeLoader {
- private static final String[] TYPES = {
- "/WEB-INF/content-types/com/arsdigita/london/contenttypes/Contact.xml"
- };
+ /** Defines the xml file containing the Contact content types property
+ * definitions. */
+ private static final String[] TYPES = {
+ "/WEB-INF/content-types/com/arsdigita/london/contenttypes/Contact.xml"
+ };
- /**
- * @see com.arsdigita.cms.contenttypes.AbstractContentTypeLoader#getTypes()
- */
+ /**
+ * Provides the of Contact contenttype property definitions implementing
+ * the parent's class abstract method.
+ *
+ * The file defines the types name as displayed in content center
+ * select box and the authoring steps. These are loaded into database.
+ *
+ * @return String Atring Array of fully qualified file names
+ */
public String[] getTypes() {
return TYPES;
}
Modified: trunk/ccm-navigation/src/com/arsdigita/navigation/Loader.java
===================================================================
--- trunk/ccm-navigation/src/com/arsdigita/navigation/Loader.java 2013-02-02 18:41:44 UTC (rev 2471)
+++ trunk/ccm-navigation/src/com/arsdigita/navigation/Loader.java 2013-02-02 18:43:41 UTC (rev 2472)
@@ -21,6 +21,10 @@
import com.arsdigita.kernel.Kernel;
import com.arsdigita.kernel.KernelExcursion;
import com.arsdigita.loader.PackageLoader;
+import com.arsdigita.navigation.portlet.ItemListPortlet;
+import com.arsdigita.navigation.portlet.NavigationTreePortlet;
+import com.arsdigita.navigation.portlet.ObjectListPortlet;
+import com.arsdigita.portal.PortletType;
import com.arsdigita.runtime.ScriptContext;
import com.arsdigita.util.UncheckedWrapperException;
import com.arsdigita.util.parameter.Parameter;
@@ -28,12 +32,6 @@
import com.arsdigita.web.Application;
import com.arsdigita.web.ApplicationType;
-import com.arsdigita.navigation.portlet.ObjectListPortlet;
-import com.arsdigita.navigation.portlet.ItemListPortlet;
-import com.arsdigita.navigation.portlet.NavigationTreePortlet;
-
-import com.arsdigita.portal.PortletType;
-
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
@@ -44,8 +42,13 @@
/**
- * Loader.
+ * Loader executes nonrecurring at install time and loads (installs and
+ * initializes) the Navigation module persistently into database.
*
+ * NOTE: Configuration parameters used at load time MUST be part of Loader
+ * class and can not delegated to a Config object (derived from AbstractConfig).
+ * They will (and can) not be persisted into an registry object (file).
+ *
* @author Justin Ross <jr...@re...>
* @version $Id: Loader.java 2070 2010-01-28 08:47:41Z pboy $
*/
@@ -60,7 +63,7 @@
"WEB-INF/navigation/templates.txt");
/**
- * Constructor
+ * Constructor, just registers parameters.
*/
public Loader() {
register( m_templatesFile );
@@ -83,8 +86,9 @@
loadObjectListPortlet();
NavigationTreePortlet.loadPortletType();
+ String templatesFile = (String)get(m_templatesFile);
try {
- setupTemplates();
+ setupTemplates(templatesFile);
} catch( IOException ex ) {
throw new UncheckedWrapperException( ex );
}
@@ -177,13 +181,20 @@
app.save();
}
- public void setupTemplates() throws IOException {
+ /**
+ * Processes a file with Navigation template specificatgions and
+ * registers JSP templates with Navigation.
+ *
+ * @param templatesFile file containing templates specification
+ * @throws IOException
+ */
+ public static void setupTemplates(String templatesFile) throws IOException {
- String templatesFile = (String)get(m_templatesFile);
InputStream file = Thread.currentThread().getContextClassLoader()
.getResourceAsStream(templatesFile);
if (file == null) {
- throw new UncheckedWrapperException(String.format("Failed to open templates files %s.", templatesFile));
+ throw new UncheckedWrapperException(String.format(
+ "Failed to open templates files %s.", templatesFile));
}
BufferedReader templates =
new BufferedReader( new InputStreamReader( file ) );
|
