Type Parameters:
R - the type of the GanttRow raw data
B - the type of the GanttBlock raw data
All Superinterfaces:
Serializable
All Known Implementing Classes:
DataCollectionTemplateGanttTimeLineRenderer, ForecastActivityDetailGanttTimeLineRenderer, GanttBaseRenderer, GanttTimeLineRenderer, GanttTreeRenderer, MultistageGroupGanttTimeLineRenderer, MultistageGroupGanttTreeRenderer, ProjectGanttTimeLineRenderer, ProjectGanttTreeRenderer

public interface GanttRenderer<R,B> extends Serializable
Class to abstract the Gantt renderer components To reduce the iteration over the GanttRows the rendering process will be driven by the GanttView object, that call the addRow(GanttView, GanttRow) method for each renderer associated. Then the GanttView will call the getHtml method to collect the generated rows, and produce the complete HTML.
  • Method Details

    • addRow

      void addRow(GanttView<R,B> view, GanttRow<R,B> row)
      Parameters:
      view - the calling GanttView
      row - the GanttRow for which generate the HTML
    • buildHtml

      org.apache.ecs.Element buildHtml(GanttView<R,B> view)
      Parameters:
      view - the calling GanttView
      Returns:
      the complete HTML generated for all the added rows.
    • buildDisplayScript

      void buildDisplayScript(GanttView<R,B> view, StringBuilder sb)
      Parameters:
      view - the calling GanttView
      sb - the StringBuilder in which append the setup script code
    • getJSVariableName

      String getJSVariableName(GanttView<R,B> view)
      Parameters:
      view - the calling GanttView
      Returns:
      the JS variable name generated for the component's client side object
    • setWidth

      void setWidth(double width)
      Parameters:
      width - the width (percentage) to set to this renderer component
    • getWidth

      double getWidth()
      Returns:
      the width (percentage) to set to this renderer component
    • setItemClickEvent

      void setItemClickEvent(String event)
      Parameters:
      event - the item click event to associate to the item HTML element
    • setItemContextMenuEvent

      void setItemContextMenuEvent(String event)
      Parameters:
      event - the context menu event to associate to the item HTML element