Source code: com/RuntimeCollective/sitemap/tag/RemoveBookmarkTag.java
1 /* $Header: /home/CVS/rjp/src/com/RuntimeCollective/sitemap/tag/RemoveBookmarkTag.java,v 1.3 2003/09/30 15:13:01 joe Exp $
2 * $Revision: 1.3 $
3 * $Date: 2003/09/30 15:13:01 $
4 *
5 * ====================================================================
6 *
7 * Josephine : http://www.runtime-collective.com/josephine/index.html
8 *
9 * Copyright (C) 2003 Runtime Collective
10 *
11 * This product includes software developed by the
12 * Apache Software Foundation (http://www.apache.org/).
13 *
14 * This library is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU Lesser General Public
16 * License as published by the Free Software Foundation; either
17 * version 2.1 of the License, or (at your option) any later version.
18 *
19 * This library is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22 * Lesser General Public License for more details.
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 *
28 */
29
30 package com.RuntimeCollective.sitemap.tag;
31
32 /** A custom JSP tag that sets the request parameters necessary for removing a site location from the user's bookmarks.
33 * It generates an <code>a href</code> tag, pointing to the <code>/addRemoveBookmark</code> action.
34 * This tag takes the following attributes:
35 * <ul>
36 * <li> <code> name </code> - the name of the bean, under page or request or session scope, that holds the id of the site location [Optional]. </li>
37 * <li> <code> scope </code> - the scope of the bean to load [Optional]. </li>
38 * <li> <code> property </code> - the property of the bean, specified by 'name', that holds the id of the site location. If this is not set, then 'id' is used. [Optional].</li>
39 * <li> <code> id </code> - the id of the site location to bookmark. [Optional].</li>
40 * <li> <code> parameter </code> - the request parameter that holds the id of the site location to unbookmark [Optional].</li>
41 * <li> <code> forward </code> - the name of the forward to go to if the site location was unbookmarked successfully. If this is not set then `success' will be returned. [Optional].</li>
42 * <li> <code> failForward </code> - the name of the forward to go to if the site location was not unbookmarked successfully. If this is not set then `failure' will be returned. [Optional].</li>
43 * </ul>
44 * Exactly one of id, parameter, or (name and property) must be set.
45 * <p><strong>Note </strong> the body of the tag should be set to the label of the link.
46 * @author Joe Holmberg
47 * @version $Id: RemoveBookmarkTag.java,v 1.3 2003/09/30 15:13:01 joe Exp $
48 */
49 public class RemoveBookmarkTag extends AddBookmarkTag {
50
51 public RemoveBookmarkTag() {
52 super();
53 addRemove = "remove";
54 }
55
56 }
57