Interface DspContext

All Superinterfaces:
RequestContext
All Known Implementing Classes:
ExtendletDspContext, ServletDspContext

public interface DspContext extends RequestContext
Author:
tomyeh
See Also:
  • Method Details

    • getLocator

      org.zkoss.util.resource.Locator getLocator()
      Returns the locator for loading resources, such as taglib. You might return null if the page not referencing external resources.

      To load the resource from a web application, use ServletContextLocator To load the resource from class path, use org.zkoss.util.resource.Resources.getDefault().

    • setContentType

      void setContentType(String ctype)
      Sets the content type of the output.
    • encodeURL

      String encodeURL(String uri) throws jakarta.servlet.ServletException, IOException
      Returns the encoded URL. The returned URL is also encoded with HttpServletResponse.encodeURL.
      Parameters:
      uri - it must be empty or starts with "/". It might contain "*" for current browser code and Locale.
      Returns:
      the complete URL (excluding the machine name). It includes the context path and the servlet to interpret this extended resource.
      Throws:
      jakarta.servlet.ServletException
      IOException
      Since:
      3.5.2
    • include

      void include(String uri, Map params) throws jakarta.servlet.ServletException, IOException
      Includes the specified URI and render the result to the specified output.
      Parameters:
      uri - the URI to include. It is OK to relevant (without leading '/'). If starts with "/", the context path of request is assumed. To reference to foreign context, use "~ctx/" where ctx is the context path of the foreign context (without leading '/').
      params - a map of parameters, or null to ignore. The map is passed thru the request attribute called arg.
      Throws:
      jakarta.servlet.ServletException
      IOException
      Since:
      3.5.2
    • isIncluded

      boolean isIncluded()
      Returns whether this page is included.
      Since:
      3.5.2
    • setOut

      void setOut(Writer out)
      Changes the writer of this context to the specified one.
      Parameters:
      out - the new writer. If null, it is restored to the default one.