Package com.atlassian.gadgets.view

Interface GadgetViewFactory

public interface GadgetViewFactory
A factory which provides a way to create ViewComponents for gadgets. A host application should use this for embedding individual gadgets in the desired locations by creating a view and then calling the ViewComponent.writeTo(java.io.Writer) method.

  • Method Details

    • createGadgetView

      @Deprecated ViewComponent createGadgetView(GadgetState state, View view, GadgetRequestContext gadgetRequestContext) throws GadgetParsingException, GadgetRenderingException
      Deprecated.
      as of 2.0, use createGadgetView(com.atlassian.gadgets.GadgetState, ModuleId, View, com.atlassian.gadgets.GadgetRequestContext)

      Returns a ViewComponent that will render the GadgetState, customizing the view based on the Locale specified in the GadgetRequestContext and the desired ViewType.

      This can be used by host applications to place gadgets anywhere they choose.

      Parameters:
      state - state of the gadget to be rendered by the ViewComponent
      view - desired View to use when rendering the gadget
      gadgetRequestContext - context info for this request to make changes to the gadget state; false if the gadget is read-only for the current viewer
      Returns:
      a ViewComponent that will render the GadgetState
      Throws:
      GadgetParsingException - thrown if there is a problem parsing the gadget spec
      GadgetRenderingException - thrown if the gadget does not define a <Content> section for the view

    • createGadgetView

      ViewComponent createGadgetView(GadgetState state, ModuleId moduleId, View view, GadgetRequestContext gadgetRequestContext) throws GadgetParsingException, GadgetRenderingException
      Returns a ViewComponent that will render the GadgetState, customizing the view based on the Locale specified in the GadgetRequestContext and the desired ViewType.
      This can be used by host applications to place gadgets anywhere they choose.
      Parameters:
      state - state of the gadget to be rendered by the ViewComponent
      moduleId - the moduleId to use in the gadget view. Should be unique for the HTML page that the gadget will be rendered in
      view - desired View to use when rendering the gadget
      gadgetRequestContext - context info for this request to make changes to the gadget state; false if the gadget is read-only for the current viewer
      Returns:
      a ViewComponent that will render the GadgetState
      Throws:
      GadgetParsingException - thrown if there is a problem parsing the gadget spec
      GadgetRenderingException - thrown if the gadget does not define a <Content> section for the view
      Since:
      2.0

    • canRenderInViewType

      boolean canRenderInViewType(GadgetState state, ViewType viewType, GadgetRequestContext gadgetRequestContext) throws GadgetParsingException
      Returns true if the gadget represented by state can be rendered with the given ViewType for the locale specified in the GadgetRequestContext.
      Parameters:
      state - state of the gadget to check if we can render
      viewType - view type to check the gadget can be rendered in
      gadgetRequestContext - the context of this request
      Returns:
      true if the gadget can be rendered with the view in the locale, false otherwise
      Throws:
      GadgetParsingException - thrown if there is a problem parsing the gadget spec