Package com.stimulsoft.report.infographics.gauge.primitives.indicators

Class StiMarkerBase

java.lang.Object
com.stimulsoft.report.infographics.gauge.primitives.base.StiElementBase
com.stimulsoft.report.infographics.gauge.primitives.base.StiGaugeElement
com.stimulsoft.report.infographics.gauge.primitives.indicators.StiIndicatorBase
com.stimulsoft.report.infographics.gauge.primitives.indicators.StiMarkerBase
All Implemented Interfaces:
IStiJsonReportObject, IStiSerializable, IStiSerializableRef, IStiApplyStyleGauge, IStiGaugeMarker, Cloneable
Direct Known Subclasses:
StiLinearMarker, StiRadialMarker
public abstract class StiMarkerBase extends StiIndicatorBase implements IStiGaugeMarker
Copyright Stimulsoft

  • Constructor Details

    • StiMarkerBase

      public StiMarkerBase()

  • Method Details

    • SaveToJsonObject

      public JSONObject SaveToJsonObject(StiJsonSaveMode mode) throws JSONException
      Specified by:
      SaveToJsonObject in interface IStiJsonReportObject
      Overrides:
      SaveToJsonObject in class StiIndicatorBase
      Throws:
      JSONException

    • LoadFromJsonObject

      public void LoadFromJsonObject(JSONObject jObject) throws JSONException
      Specified by:
      LoadFromJsonObject in interface IStiJsonReportObject
      Overrides:
      LoadFromJsonObject in class StiIndicatorBase
      Throws:
      JSONException

    • clone

      public Object clone()
      Description copied from class: StiElementBase
      Creates a new object that is a copy of the current instance.
      Overrides:
      clone in class StiIndicatorBase

    • getOffset

      public double getOffset()
      offset of the scale object from the scale bar.
      Returns:
      the offset

    • setOffset

      public void setOffset(double offset)
      offset of the scale object from the scale bar.
      Parameters:
      offset - the offset to set

    • getRelativeWidth

      public double getRelativeWidth()
      relative width of the indicator. It is given as part of the scale dimension.
      Returns:
      the relativeWidth

    • setRelativeWidth

      public void setRelativeWidth(double relativeWidth)
      relative width of the indicator. It is given as part of the scale dimension.
      Parameters:
      relativeWidth - the relativeWidth to set

    • getRelativeHeight

      public double getRelativeHeight()
      relative height of the indicator. It is given as part of the scale dimension.
      Returns:
      the relativeHeight

    • setRelativeHeight

      public void setRelativeHeight(double relativeHeight)
      relative height of the indicator. It is given as part of the scale dimension.
      Parameters:
      relativeHeight - the relativeHeight to set

    • getSkin

      public StiMarkerSkin getSkin()
      the skin of the component rendering.
      Returns:
      the skin

    • setSkin

      public void setSkin(StiMarkerSkin skin)
      the skin of the component rendering.
      Parameters:
      skin - the skin to set

    • getCustomSkin

      public StiGaugeElementSkin getCustomSkin()
      Returns:
      the customSkin

    • setCustomSkin

      public void setCustomSkin(StiGaugeElementSkin customSkin)
      Parameters:
      customSkin - the customSkin to set

    • getFormat

      public String getFormat()
      the format string for the ShowValue property.
      Specified by:
      getFormat in interface IStiGaugeMarker
      Returns:
      the format

    • setFormat

      public void setFormat(String format)
      the format string for the ShowValue property.
      Specified by:
      setFormat in interface IStiGaugeMarker
      Parameters:
      format - the format to set

    • isShowValue

      public boolean isShowValue()
      a value indicating whether to display a current value of the indicator.
      Specified by:
      isShowValue in interface IStiGaugeMarker
      Returns:
      the showValue

    • setShowValue

      public void setShowValue(boolean showValue)
      a value indicating whether to display a current value of the indicator.
      Specified by:
      setShowValue in interface IStiGaugeMarker
      Parameters:
      showValue - the showValue to set

    • getTextBrush

      public StiBrush getTextBrush()
      a brush to draw text.
      Specified by:
      getTextBrush in interface IStiGaugeMarker
      Returns:
      the textBrush

    • setTextBrush

      public void setTextBrush(StiBrush textBrush)
      a brush to draw text.
      Specified by:
      setTextBrush in interface IStiGaugeMarker
      Parameters:
      textBrush - the textBrush to set

    • getFont

      public StiFont getFont()
      font of component.
      Specified by:
      getFont in interface IStiGaugeMarker
      Returns:
      the font

    • setFont

      public void setFont(StiFont font)
      font of component.
      Specified by:
      setFont in interface IStiGaugeMarker
      Parameters:
      font - the font to set

    • getActualSkin

      protected StiGaugeElementSkin getActualSkin()