VelocityTaglib.java :  » Portal » liferay-portal-4.4.2 » com » liferay » taglib » util » Java Open Source

/**
 * Copyright (c) 2000-2008 Liferay, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package com.liferay.taglib.util;

import com.liferay.portal.kernel.servlet.StringServletResponse;
import com.liferay.portal.model.Layout;
import com.liferay.taglib.portlet.ActionURLTag;
import com.liferay.taglib.portletext.IconBackTag;
import com.liferay.taglib.portletext.IconCloseTag;
import com.liferay.taglib.portletext.IconConfigurationTag;
import com.liferay.taglib.portletext.IconEditDefaultsTag;
import com.liferay.taglib.portletext.IconEditGuestTag;
import com.liferay.taglib.portletext.IconEditTag;
import com.liferay.taglib.portletext.IconHelpTag;
import com.liferay.taglib.portletext.IconMaximizeTag;
import com.liferay.taglib.portletext.IconMinimizeTag;
import com.liferay.taglib.portletext.IconPortletCssTag;
import com.liferay.taglib.portletext.IconPortletTag;
import com.liferay.taglib.portletext.IconPrintTag;
import com.liferay.taglib.portletext.IconRefreshTag;
import com.liferay.taglib.portletext.RuntimeTag;
import com.liferay.taglib.portletext.TitleTag;
import com.liferay.taglib.security.DoAsURLTag;
import com.liferay.taglib.security.PermissionsURLTag;
import com.liferay.taglib.theme.LayoutIconTag;
import com.liferay.taglib.theme.MetaTagsTag;
import com.liferay.taglib.theme.WrapPortletTag;
import com.liferay.taglib.ui.JournalContentSearchTag;
import com.liferay.taglib.ui.LanguageTag;
import com.liferay.taglib.ui.MyPlacesTag;
import com.liferay.taglib.ui.PngImageTag;
import com.liferay.taglib.ui.SearchTag;
import com.liferay.taglib.ui.ToggleTag;
import com.liferay.util.HttpUtil;

import java.util.Map;

import javax.portlet.PortletMode;
import javax.portlet.WindowState;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.jsp.PageContext;

/**
 * <a href="VelocityTaglib.java.html"><b><i>View Source</i></b></a>
 *
 * @author Brian Wing Shun Chan
 *
 */
public class VelocityTaglib {

  public VelocityTaglib() {
  }

  public VelocityTaglib(
    ServletContext ctx, HttpServletRequest req, StringServletResponse res,
    PageContext pageContext) {

    init(ctx, req, res, pageContext);
  }

  public VelocityTaglib init(
    ServletContext ctx, HttpServletRequest req, StringServletResponse res,
    PageContext pageContext) {

    _ctx = ctx;
    _req = req;
    _res = res;
    _pageContext = pageContext;

    return this;
  }

  public String actionURL(String portletName, String queryString)
    throws Exception {

    String windowState = WindowState.NORMAL.toString();
    String portletMode = PortletMode.VIEW.toString();

    return actionURL(windowState, portletMode, portletName, queryString);
  }

  public String actionURL(
      String windowState, String portletMode, String portletName,
      String queryString)
    throws Exception {

    Boolean secure = null;
    Boolean anchor = null;
    Boolean encrypt = null;
    long doAsUserId = 0;
    Boolean portletConfiguration = null;

    return actionURL(
      windowState, portletMode, secure, portletName, anchor, encrypt,
      doAsUserId, portletConfiguration, queryString);
  }

  public String actionURL(
      String windowState, String portletMode, Boolean secure,
      String portletName, Boolean anchor, Boolean encrypt,
      long doAsUserId, Boolean portletConfiguration, String queryString)
    throws Exception {

    Map params = HttpUtil.parameterMapFromString(queryString);

    return ActionURLTag.doTag(
      true, windowState, portletMode, null, null, secure, portletName,
      anchor, encrypt, doAsUserId, portletConfiguration, params, false,
      _pageContext);
  }

  public String doAsURL(long doAsUserId) throws Exception {
    return DoAsURLTag.doTag(doAsUserId, null, false, _pageContext);
  }

  public String iconBack() throws Exception {
    _res.recycle();

    IconBackTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconBack(String page) throws Exception {
    _res.recycle();

    IconBackTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconClose() throws Exception {
    _res.recycle();

    IconCloseTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconClose(String page) throws Exception {
    _res.recycle();

    IconCloseTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconConfiguration() throws Exception {
    _res.recycle();

    IconConfigurationTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconConfiguration(String page) throws Exception {
    _res.recycle();

    IconConfigurationTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconEdit() throws Exception {
    _res.recycle();

    IconEditTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconEdit(String page) throws Exception {
    _res.recycle();

    IconEditTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconEditDefaults() throws Exception {
    _res.recycle();

    IconEditDefaultsTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconEditGuest() throws Exception {
    _res.recycle();

    IconEditGuestTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconEditGuest(String page) throws Exception {
    _res.recycle();

    IconEditGuestTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconHelp() throws Exception {
    _res.recycle();

    IconHelpTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconHelp(String page) throws Exception {
    _res.recycle();

    IconHelpTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconMaximize() throws Exception {
    _res.recycle();

    IconMaximizeTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconMaximize(String page) throws Exception {
    _res.recycle();

    IconMaximizeTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconMinimize() throws Exception {
    _res.recycle();

    IconMinimizeTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconMinimize(String page) throws Exception {
    _res.recycle();

    IconMinimizeTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconPortlet() throws Exception {
    _res.recycle();

    IconPortletTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconPortlet(String page) throws Exception {
    _res.recycle();

    IconPortletTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconPortletCss() throws Exception {
    _res.recycle();

    IconPortletCssTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconPortletCss(String page) throws Exception {
    _res.recycle();

    IconPortletCssTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconPrint() throws Exception {
    _res.recycle();

    IconPrintTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconPrint(String page) throws Exception {
    _res.recycle();

    IconPrintTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String iconRefresh() throws Exception {
    _res.recycle();

    IconRefreshTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String iconRefresh(String page) throws Exception {
    _res.recycle();

    IconRefreshTag.doTag(page, _ctx, _req, _res);

    return _res.getString();
  }

  public String include(String page) throws Exception {
    _res.recycle();

    RequestDispatcher rd = _ctx.getRequestDispatcher(page);

    rd.include(_req, _res);

    return _res.getString();
  }

  public String journalContentSearch() throws Exception {
    _res.recycle();

    JournalContentSearchTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String language() throws Exception {
    _res.recycle();

    LanguageTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String language(
      String formName, String formAction, String name, int displayStyle)
    throws Exception {

    _res.recycle();

    LanguageTag.doTag(
      formName, formAction, name, null, displayStyle, _ctx, _req, _res);

    return _res.getString();
  }

  public String language(
      String formName, String formAction, String name,
      String[] languageIds, int displayStyle)
    throws Exception {

    _res.recycle();

    LanguageTag.doTag(
      formName, formAction, name, languageIds, displayStyle, _ctx, _req,
      _res);

    return _res.getString();
  }

  public String language(
      String page, String formName, String formAction, String name,
      int displayStyle)
    throws Exception {

    _res.recycle();

    LanguageTag.doTag(
      page, formName, formAction, name, null, displayStyle, _ctx, _req,
      _res);

    return _res.getString();
  }

  public String language(
      String page, String formName, String formAction, String name,
      String[] languageIds, int displayStyle)
    throws Exception {

    _res.recycle();

    LanguageTag.doTag(
      page, formName, formAction, name, languageIds, displayStyle, _ctx,
      _req, _res);

    return _res.getString();
  }

  public String layoutIcon(Layout layout) throws Exception {
    _res.recycle();

    LayoutIconTag.doTag(layout, _ctx, _req, _res);

    return _res.getString();
  }

  public String metaTags() throws Exception {
    _res.recycle();

    MetaTagsTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String myPlaces() throws Exception {
    _res.recycle();

    MyPlacesTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String permissionsURL(
      String redirect, String modelResource,
      String modelResourceDescription, String resourcePrimKey)
    throws Exception {

    return PermissionsURLTag.doTag(
      redirect, modelResource, modelResourceDescription, resourcePrimKey,
      null, false, _pageContext);
  }

  public String pngImage(String image, String height, String width)
    throws Exception {

    _res.recycle();

    PngImageTag.doTag(image, height, width, _ctx, _req, _res);

    return _res.getString();
  }

  public String renderURL(String portletName, String queryString)
    throws Exception {

    String windowState = WindowState.NORMAL.toString();
    String portletMode = PortletMode.VIEW.toString();

    return renderURL(windowState, portletMode, portletName, queryString);
  }

  public String renderURL(
      String windowState, String portletMode, String portletName,
      String queryString)
    throws Exception {

    Boolean secure = null;
    Boolean anchor = null;
    Boolean encrypt = null;
    long doAsUserId = 0;
    Boolean portletConfiguration = null;

    return renderURL(
      windowState, portletMode, secure, portletName, anchor, encrypt,
      doAsUserId, portletConfiguration, queryString);
  }

  public String renderURL(
      String windowState, String portletMode, Boolean secure,
      String portletName, Boolean anchor, Boolean encrypt,
      long doAsUserId, Boolean portletConfiguration, String queryString)
    throws Exception {

    Map params = HttpUtil.parameterMapFromString(queryString);

    return ActionURLTag.doTag(
      false, windowState, portletMode, null, null, secure, portletName,
      anchor, encrypt, doAsUserId, portletConfiguration, params, false,
      _pageContext);
  }

  public String runtime(String portletName)
    throws Exception {

    return runtime(portletName, null);
  }

  public String runtime(String portletName, String queryString)
    throws Exception {

    _res.recycle();

    RuntimeTag.doTag(portletName, queryString, null, _ctx, _req, _res);

    return _res.getString();
  }

  public String runtime(
      String portletName, String queryString, String defaultPreferences)
    throws Exception {

    _res.recycle();

    RuntimeTag.doTag(
      portletName, queryString, defaultPreferences, null, _ctx, _req,
      _res);

    return _res.getString();
  }

  public String search() throws Exception {
    _res.recycle();

    SearchTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String title() throws Exception {
    _res.recycle();

    TitleTag.doTag(_ctx, _req, _res);

    return _res.getString();
  }

  public String title(boolean editable) throws Exception {
    _res.recycle();

    TitleTag.doTag(editable, _ctx, _req, _res);

    return _res.getString();
  }

  public String toggle(
      String id, String onImage, String offImage, boolean defaultOn)
    throws Exception {

    _res.recycle();

    ToggleTag.doTag(
      id, onImage, offImage, defaultOn, null, _ctx, _req, _res);

    return _res.getString();
  }

  public String wrapPortlet(String wrapPage, String portletPage)
    throws Exception {

    _res.recycle();

    return WrapPortletTag.doTag(
      wrapPage, portletPage, _ctx, _req, _res, _pageContext);
  }

  private ServletContext _ctx;
  private HttpServletRequest _req;
  private StringServletResponse _res;
  private PageContext _pageContext;

}