001: /**
002: * $Id: FormNames.java,v 1.1 2006/04/13 17:57:11 jtb Exp $
003: * Copyright 2004 Sun Microsystems, Inc. All
004: * rights reserved. Use of this product is subject
005: * to license terms. Federal Acquisitions:
006: * Commercial Software -- Government Users
007: * Subject to Standard License Terms and
008: * Conditions.
009: *
010: * Sun, Sun Microsystems, the Sun logo, and Sun ONE
011: * are trademarks or registered trademarks of Sun Microsystems,
012: * Inc. in the United States and other countries.
013: */package com.sun.portal.rssportlet;
014:
015: /**
016: * This class provides helper constants for use within the Rss Portlet JSPs.
017: *
018: * There are several categories of constants:
019: * <ul>
020: * <li> Markup element names
021: * <li> Portlet preference names
022: * <li> Error parameter names
023: * </ul>
024: * <p>
025: * If the portlet's JSPs are customized, it is important to use the
026: * constant markup element names specified in this interface. If these
027: * constants are not used, the portlet cannot process form submissions,
028: * and Javascript in the JSPs may fail.
029: * </p>
030: * <p>
031: * Portlet preference name constants are provided for convenience
032: * as the JSPs read the preferences when rendering the portlet.
033: * </p>
034: * <p>
035: * Error parameters are used to pass error information between the
036: * portlet class and the edit JSP. Error parameters are set as
037: * portlet render parameters. The existence or non-existence of
038: * the error parameter is a flag indicating if the error occured.
039: * The value of the error parameter may simply be "true",
040: * or it may include some information about the error. See descriptions
041: * of the error parameters for details.
042: * </p>
043: * <p>
044: * <b>This API is unstable and changing.</b>
045: * </p>
046: */
047:
048: public interface FormNames {
049: /**
050: * Markup element name of the select feed drop down list in
051: * the portlet's view mode.
052: */
053: public static final String INPUT_SELECT_FEED = "selectFeed";
054:
055: /**
056: * Markup element name of the feeds check box group
057: * in the portlet's edit mode.
058: */
059: public static final String INPUT_FEEDS = "feeds";
060:
061: /**
062: * Markup element name of the "add feed" button in the portlet's
063: * edit mode.
064: */
065: public static final String INPUT_ADD_FEED = "inputAddFeed";
066:
067: /**
068: * Markup element name of the "maximum feed age" text box
069: * in the portlet's edit mode
070: */
071: public static final String INPUT_MAX_AGE = "inputMaxAge";
072:
073: /**
074: * Markup element name of the "new window" check box in the
075: * portlet's edit mode.
076: */
077: public static final String INPUT_NEWWIN = "inputNewWindow";
078:
079: /**
080: * Markup element name for the "maximum entries" text box in the
081: * portlet's edit mode.
082: **/
083: public static final String INPUT_MAX_ENTRIES = "inputMaxEntries";
084:
085: /**
086: ** Markup element name for the "disable maximum feed age"
087: * check box in the portlet's edit mode.
088: */
089: public static final String INPUT_DISABLE_MAX_AGE = "disableMaxAge";
090:
091: /**
092: * Markup element name for the "start feed" drop down list in the
093: * portlet's edit mode.
094: */
095: public static final String INPUT_START_FEED = "showAllEntries";
096:
097: /**
098: * Markup element name for the "add new feed" submit button
099: * in the portlet's edit mode.
100: */
101: public static final String SUBMIT_ADD = "submitAdd";
102:
103: /**
104: * Markup element name for the "finished" button in the
105: * portlet's edit mode.
106: */
107: public static final String SUBMIT_EDIT = "submitEdit";
108:
109: /** Markup element for the "cancel" button. */
110: public static final String SUBMIT_CANCEL = "submitCancel";
111:
112: /**
113: * Markup element name for the "go" button in the
114: * portlet's view mode.
115: */
116: public static final String SUBMIT_GO = "submitGo";
117: }
|