001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.taglib.ui;
016    
017    import com.liferay.portal.kernel.util.Validator;
018    import com.liferay.portal.util.PortalUtil;
019    import com.liferay.taglib.util.IncludeTag;
020    
021    import java.util.Map;
022    
023    import javax.servlet.http.HttpServletRequest;
024    
025    /**
026     * @author Brian Wing Shun Chan
027     */
028    public class IconTag extends IncludeTag {
029    
030            @Override
031            public int doStartTag() {
032                    return EVAL_BODY_INCLUDE;
033            }
034    
035            public void setAlt(String alt) {
036                    _alt = alt;
037            }
038    
039            public void setCssClass(String cssClass) {
040                    _cssClass = cssClass;
041            }
042    
043            public void setData(Map<String, Object> data) {
044                    _data = data;
045            }
046    
047            public void setId(String id) {
048                    _id = id;
049            }
050    
051            public void setImage(String image) {
052                    _image = image;
053            }
054    
055            public void setImageHover(String imageHover) {
056                    _imageHover = imageHover;
057            }
058    
059            public void setLabel(boolean label) {
060                    _label = label;
061            }
062    
063            public void setLang(String lang) {
064                    _lang = lang;
065            }
066    
067            public void setMessage(String message) {
068                    _message = message;
069            }
070    
071            public void setMethod(String method) {
072                    _method = method;
073            }
074    
075            public void setOnClick(String onClick) {
076                    _onClick = onClick;
077            }
078    
079            public void setSrc(String src) {
080                    _src = src;
081            }
082    
083            public void setSrcHover(String srcHover) {
084                    _srcHover = srcHover;
085            }
086    
087            public void setTarget(String target) {
088                    _target = target;
089            }
090    
091            public void setToolTip(boolean toolTip) {
092                    _toolTip = toolTip;
093            }
094    
095            public void setUrl(String url) {
096                    _url = url;
097            }
098    
099            @Override
100            protected void cleanUp() {
101                    _alt = null;
102                    _cssClass = null;
103                    _data = null;
104                    _id = null;
105                    _image = null;
106                    _imageHover = null;
107                    _label = false;
108                    _lang = null;
109                    _message = null;
110                    _method = null;
111                    _onClick = null;
112                    _src = null;
113                    _srcHover = null;
114                    _target = null;
115                    _toolTip = false;
116                    _url = null;
117            }
118    
119            protected String getMessage() {
120                    return _message;
121            }
122    
123            @Override
124            protected String getPage() {
125                    return _PAGE;
126            }
127    
128            protected String getUrl() {
129                    return _url;
130            }
131    
132            @Override
133            protected boolean isCleanUpSetAttributes() {
134                    return _CLEAN_UP_SET_ATTRIBUTES;
135            }
136    
137            @Override
138            protected void setAttributes(HttpServletRequest request) {
139                    String id = _id;
140    
141                    if (Validator.isNull(id)) {
142                            id = PortalUtil.generateRandomKey(request, IconTag.class.getName());
143                    }
144    
145                    request.setAttribute("liferay-ui:icon:alt", _alt);
146                    request.setAttribute("liferay-ui:icon:cssClass", _cssClass);
147                    request.setAttribute("liferay-ui:icon:data", _data);
148                    request.setAttribute("liferay-ui:icon:id", id);
149                    request.setAttribute("liferay-ui:icon:image", _image);
150                    request.setAttribute("liferay-ui:icon:imageHover", _imageHover);
151                    request.setAttribute("liferay-ui:icon:label", String.valueOf(_label));
152                    request.setAttribute("liferay-ui:icon:lang", _lang);
153                    request.setAttribute("liferay-ui:icon:message", _message);
154                    request.setAttribute("liferay-ui:icon:method", _method);
155                    request.setAttribute("liferay-ui:icon:onClick", _onClick);
156                    request.setAttribute("liferay-ui:icon:src", _src);
157                    request.setAttribute("liferay-ui:icon:srcHover", _srcHover);
158                    request.setAttribute("liferay-ui:icon:target", _target);
159                    request.setAttribute(
160                            "liferay-ui:icon:toolTip", String.valueOf(_toolTip));
161                    request.setAttribute("liferay-ui:icon:url", _url);
162            }
163    
164            private static final boolean _CLEAN_UP_SET_ATTRIBUTES = true;
165    
166            private static final String _PAGE = "/html/taglib/ui/icon/page.jsp";
167    
168            private String _alt;
169            private String _cssClass;
170            private Map<String, Object> _data;
171            private String _id;
172            private String _image;
173            private String _imageHover;
174            private boolean _label;
175            private String _lang;
176            private String _message;
177            private String _method;
178            private String _onClick;
179            private String _src;
180            private String _srcHover;
181            private String _target = "_self";
182            private boolean _toolTip;
183            private String _url;
184    
185    }