001    /**
002     * Copyright (c) 2000-present 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.portal.kernel.portlet.configuration.icon;
016    
017    import java.io.IOException;
018    
019    import java.util.Map;
020    
021    import javax.portlet.PortletRequest;
022    import javax.portlet.PortletResponse;
023    
024    import javax.servlet.http.HttpServletRequest;
025    import javax.servlet.http.HttpServletResponse;
026    
027    /**
028     * @author Eudaldo Alonso
029     */
030    public interface PortletConfigurationIcon {
031    
032            public String getAlt();
033    
034            public String getAriaRole();
035    
036            public String getCssClass();
037    
038            public Map<String, Object> getData();
039    
040            public String getIconCssClass();
041    
042            public String getId();
043    
044            public String getImage();
045    
046            public String getImageHover();
047    
048            public String getLang();
049    
050            public String getLinkCssClass();
051    
052            public String getMessage(PortletRequest portletRequest);
053    
054            public String getMethod();
055    
056            public String getOnClick(
057                    PortletRequest portletRequest, PortletResponse portletResponse);
058    
059            public String getSrc();
060    
061            public String getSrcHover();
062    
063            public String getTarget();
064    
065            public String getURL(
066                    PortletRequest portletRequest, PortletResponse portletResponse);
067    
068            public double getWeight();
069    
070            public boolean include(
071                            HttpServletRequest request, HttpServletResponse response)
072                    throws IOException;
073    
074            public boolean isLabel();
075    
076            public boolean isShow(PortletRequest portletRequest);
077    
078            public boolean isToolTip();
079    
080            public boolean isUseDialog();
081    
082    }