Class TimescaleTier


  • public final class TimescaleTier
    extends Object

    Represents a single tier of the timescale on a Gantt Chart.

    • Constructor Detail

      • TimescaleTier

        public TimescaleTier()

        Initializes a new instance of the TimescaleTier class.

      • TimescaleTier

        public TimescaleTier​(int unit,
                             int count)

        Initializes a new instance of the TimescaleTier class.

        Parameters:
        unit - The timescale unit TimescaleUnit.
        count - The count of TimescaleUnit units.
    • Method Detail

      • setAlignment

        public final void setAlignment​(int value)

        Sets how to align labels within each time period of the tier (HorizontalStringAlignment).

        Parameters:
        value - how to align labels within each time period of the tier (HorizontalStringAlignment).
      • getCount

        public final int getCount()

        Gets the time unit interval in which to show labels for the tier. The default value is 1.

        Returns:
        the time unit interval in which to show labels for the tier.
      • setCount

        public final void setCount​(int value)

        Sets the time unit interval in which to show labels for the tier. The default value is 1.

        Parameters:
        value - the time unit interval in which to show labels for the tier.
      • getDateTimeConverter

        public final DateTimeConverter getDateTimeConverter()

        Gets a callback function for handling rendering date tick in this tier.

        Returns:
        a callback function for handling rendering date tick in this tier.
      • setDateTimeConverter

        public final void setDateTimeConverter​(DateTimeConverter value)

        Sets a callback function for handling rendering date tick in this tier.

        Parameters:
        value - a callback function for handling rendering date tick in this tier.
      • getLabel

        public final int getLabel()

        Gets date label DateLabel for the timescale tier.

        Returns:
        date label DateLabel for the timescale tier.
      • setLabel

        public final void setLabel​(int value)

        Sets date label DateLabel for the timescale tier.

        Parameters:
        value - date label DateLabel for the timescale tier.
      • getRenderLabelOnEachPage

        public final boolean getRenderLabelOnEachPage()

        Gets flag that defines whether date labels should be rendered on each page when a time period spans over several pages. If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page. If values is 'false', date label is rendered only once according to a value of Alignment(getAlignment()/setAlignment(int)) property.


        Doesn't have the equivalent in MS Project.

        Returns:
        flag that defines whether date labels should be rendered on each page when a time period spans over several pages.
      • setRenderLabelOnEachPage

        public final void setRenderLabelOnEachPage​(boolean value)

        Sets flag that defines whether date labels should be rendered on each page when a time period spans over several pages. If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page. If values is 'false', date label is rendered only once according to a value of Alignment(getAlignment()/setAlignment(int)) property.


        Doesn't have the equivalent in MS Project.

        Parameters:
        value - flag that defines whether date labels should be rendered on each page when a time period spans over several pages.
      • getShowTicks

        public final boolean getShowTicks()

        Gets a value indicating whether whether to show tick marks that separate time periods in the tier.

        Returns:
        a value indicating whether whether to show tick marks that separate time periods in the tier.
      • setShowTicks

        public final void setShowTicks​(boolean value)

        Sets a value indicating whether whether to show tick marks that separate time periods in the tier.

        Parameters:
        value - a value indicating whether whether to show tick marks that separate time periods in the tier.
      • setUnit

        public final void setUnit​(int value)

        Sets timescale unit TimescaleUnit for the timescale tier. The default value is TimescaleUnit.

        Parameters:
        value - timescale unit TimescaleUnit for the timescale tier.
      • getUsesFiscalYear

        public final boolean getUsesFiscalYear()

        Gets a value indicating whether to base the tier labels on the fiscal year.

        Returns:
        a value indicating whether to base the tier labels on the fiscal year.
      • setUsesFiscalYear

        public final void setUsesFiscalYear​(boolean value)

        Sets a value indicating whether to base the tier labels on the fiscal year.

        Parameters:
        value - a value indicating whether to base the tier labels on the fiscal year.