Package org.pentaho.reporting.engine.classic.core.modules.misc.survey

Class SurveyScale

    • Constructor Detail

      • SurveyScale

        public SurveyScale()
        Creates a new default instance.

      • SurveyScale

        public SurveyScale​(int lowest,
                   int highest,
                   Number[] values)
        Creates a new instance.
        Parameters:
        lowest - the lowest response value on the scale.
        highest - the highest response value on the scale.
        values - the values to display.

    • Method Detail

      • isAutoConfigure

        public boolean isAutoConfigure()

      • setAutoConfigure

        public void setAutoConfigure​(boolean autoConfigure)

      • getLowest

        public int getLowest()

      • setLowest

        public void setLowest​(int lowest)

      • getHighest

        public int getHighest()

      • setHighest

        public void setHighest​(int highest)

      • recompute

        protected void recompute()
        This method is called whenever lowest or highest has changed. It will recompute the range and upper and lower bounds.

      • getRange

        protected int getRange()

      • setRange

        protected void setRange​(int range)

      • getLowerBound

        protected double getLowerBound()

      • setLowerBound

        protected void setLowerBound​(double lowerBound)

      • getUpperBound

        protected double getUpperBound()

      • setUpperBound

        protected void setUpperBound​(double upperBound)

      • createShapeList

        protected ArrayList<Shape> createShapeList()
        Creates the shape list used when drawing the scale. The list returned must contain exactly 6 elements.
        Returns:

      • createDiamond

        public static Shape createDiamond​(float s)
        Creates a diamond shape.
        Parameters:
        s - the size factor (equal to half the height of the diamond).
        Returns:
        A diamond shape.

      • createUpTriangle

        public static Shape createUpTriangle​(float s)
        Creates a triangle shape that points upwards.
        Parameters:
        s - the size factor (equal to half the height of the triangle).
        Returns:
        A triangle shape.

      • createDownTriangle

        public static Shape createDownTriangle​(float s)
        Creates a triangle shape that points downwards.
        Parameters:
        s - the size factor (equal to half the height of the triangle).
        Returns:
        A triangle shape.

      • getRangeLowerBound

        public Number getRangeLowerBound()
        Returns the lower bound of the highlighted range. A null value indicates that no range is set for highlighting.
        Returns:
        The lower bound (possibly null).

      • setRangeLowerBound

        public void setRangeLowerBound​(Number bound)
        Sets the lower bound for the range that is highlighted on the scale.
        Parameters:
        bound - the lower bound (null permitted).

      • getRangeUpperBound

        public Number getRangeUpperBound()
        Returns the upper bound of the highlighted range. A null value indicates that no range is set for highlighting.
        Returns:
        The upper bound (possibly null).

      • setRangeUpperBound

        public void setRangeUpperBound​(Number bound)
        Sets the upper bound for the range that is highlighted on the scale.
        Parameters:
        bound - the upper bound (null permitted).

      • isDrawTickMarks

        public boolean isDrawTickMarks()
        Returns the flag that controls whether the tick marks are drawn.
        Returns:
        A boolean.

      • setDrawTickMarks

        public void setDrawTickMarks​(boolean flag)
        Sets the flag that controls whether the tick marks are drawn.
        Parameters:
        flag - a boolean.

      • isDrawScaleValues

        public boolean isDrawScaleValues()
        Returns a flag that controls whether or not scale values are drawn.
        Returns:
        a boolean.

      • setDrawScaleValues

        public void setDrawScaleValues​(boolean flag)
        Sets a flag that controls whether or not scale values are drawn.
        Parameters:
        flag - the flag.

      • getScaleValueFont

        public Font getScaleValueFont()
        Returns the font used to display the scale values.
        Returns:
        A font (never null).

      • setScaleValueFont

        public void setScaleValueFont​(Font font)
        Sets the font used to display the scale values.
        Parameters:
        font - the font (null not permitted).

      • getScaleValuePaint

        public Paint getScaleValuePaint()
        Returns the color used to draw the scale values (if they are visible).
        Returns:
        A paint (never null).

      • setScaleValuePaint

        public void setScaleValuePaint​(Paint paint)
        Sets the color used to draw the scale values.
        Parameters:
        paint - the paint (null not permitted).

      • getShape

        public Shape getShape​(int index)
        Returns the shape used to indicate the value of a response.
        Parameters:
        index - the value index (zero-based).
        Returns:
        The shape.

      • setShape

        public void setShape​(int index,
                     Shape shape)
        Sets the shape used to mark a particular value in the dataset.
        Parameters:
        index - the value index (zero-based).
        shape - the shape (null not permitted).

      • setShape

        public void setShape​(int index,
                     SurveyScaleShapeType shape)
        Sets the shape used to mark a particular value in the dataset.
        Parameters:
        index - the value index (zero-based).
        shape - the shape (null not permitted).

      • isShapeFilled

        public boolean isShapeFilled​(int index)
        Returns a flag that controls whether the shape for a particular value should be filled.
        Parameters:
        index - the value index (zero-based).
        Returns:
        A boolean.

      • setShapeFilled

        public void setShapeFilled​(int index,
                           boolean fill)
        Sets the flag that controls whether the shape for a particular value should be filled.
        Parameters:
        index - the value index (zero-based).
        fill - the flag.

      • getRangePaint

        public Paint getRangePaint()
        Returns the paint used to highlight the range.
        Returns:
        A Paint object (never null).

      • setRangePaint

        public void setRangePaint​(Paint paint)
        Sets the paint used to highlight the range (if one is specified).
        Parameters:
        paint - the paint (null not permitted).

      • getDefaultShape

        public Shape getDefaultShape()
        Returns the default shape, which is used, if a shape for a certain value is not defined.
        Returns:
        the default shape, never null.

      • setDefaultShape

        public void setDefaultShape​(Shape defaultShape)
        Redefines the default shape.
        Parameters:
        defaultShape - the default shape
        Throws:
        NullPointerException - if the given shape is null.

      • getTickMarkPaint

        public Paint getTickMarkPaint()

      • setTickMarkPaint

        public void setTickMarkPaint​(Paint tickMarkPaint)

      • getValues

        public Number[] getValues()

      • getFillPaint

        public Paint getFillPaint()

      • setFillPaint

        public void setFillPaint​(Paint fillPaint)

      • getOutlineStroke

        public Stroke getOutlineStroke()

      • setOutlineStroke

        public void setOutlineStroke​(Stroke outlineStroke)

      • getUpperMargin

        public double getUpperMargin()

      • setUpperMargin

        public void setUpperMargin​(double upperMargin)

      • getLowerMargin

        public double getLowerMargin()

      • setLowerMargin

        public void setLowerMargin​(double lowerMargin)

      • setConfiguration

        public void setConfiguration​(org.pentaho.reporting.libraries.base.config.Configuration config)
        Provides the current report configuration of the current report process to the drawable. The report configuration can be used to configure the drawing process through the report.
        Specified by:
        setConfiguration in interface ReportDrawable
        Parameters:
        config - the report configuration.

      • setStyleSheet

        public void setStyleSheet​(StyleSheet style)
        Provides the computed stylesheet of the report element that contained this drawable. The stylesheet is immutable.
        Specified by:
        setStyleSheet in interface ReportDrawable
        Parameters:
        style - the stylesheet.

      • getStyleSheet

        public StyleSheet getStyleSheet()

      • setResourceBundleFactory

        public void setResourceBundleFactory​(ResourceBundleFactory bundleFactory)
        Defines the resource-bundle factory that can be used to localize the drawing process.
        Specified by:
        setResourceBundleFactory in interface ReportDrawable
        Parameters:
        bundleFactory - the resource-bundle factory.

      • getImageMap

        public ImageMap getImageMap​(Rectangle2D bounds)
        Description copied from interface: ReportDrawable
        Returns an optional image-map for the entry.
        Specified by:
        getImageMap in interface ReportDrawable
        Parameters:
        bounds - the bounds for which the image map is computed.
        Returns:
        the computed image-map or null if there is no image-map available.