Package org.opencms.gwt.shared

Class CmsQuickLaunchParams

  • All Implemented Interfaces:
    com.google.gwt.user.client.rpc.IsSerializable
    public class CmsQuickLaunchParams
extends java.lang.Object
implements com.google.gwt.user.client.rpc.IsSerializable
    Parameters used by the quick launch provider.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected CmsQuickLaunchParams()
      Default constructor for serialization.
        CmsQuickLaunchParams​(java.lang.String context, CmsUUID pageId, CmsUUID detailId, java.lang.String returnCode, java.lang.String path)
      Creates a new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getContext()
      Returns the context.
      CmsUUID getDetailId()
      Returns the detailId.
      CmsUUID getPageId()
      Returns the pageId.
      java.lang.String getPath()
      Gets the path.
      java.lang.String getReturnCode()
      Returns the returnCode.
      boolean isPageContext()
      Returns true if the quick launcher is called from the page editor.
      boolean isSitemapContext()
      Returns true if the quick launcher is called from the sitemap editor.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsQuickLaunchParams

        public CmsQuickLaunchParams​(java.lang.String context,
                            CmsUUID pageId,
                            CmsUUID detailId,
                            java.lang.String returnCode,
                            java.lang.String path)
        Creates a new instance.

        Parameters:
        context - the quick launch context
        pageId - the page id
        detailId - the detail content id
        returnCode - the return code
        path - the path

    • Method Detail

      • getContext

        public java.lang.String getContext()
        Returns the context.

        Returns:
        the context

      • getPageId

        public CmsUUID getPageId()
        Returns the pageId.

        Returns:
        the pageId

      • getPath

        public java.lang.String getPath()
        Gets the path.

        Returns:
        the path

      • getReturnCode

        public java.lang.String getReturnCode()
        Returns the returnCode.

        Returns:
        the returnCode

      • isPageContext

        public boolean isPageContext()
        Returns true if the quick launcher is called from the page editor.

        Returns:
        true if the quick launcher was called from the page editor

      • isSitemapContext

        public boolean isSitemapContext()
        Returns true if the quick launcher is called from the sitemap editor.

        Returns:
        true if the quick launcher was called from the sitemap editor