com.softwarefx.chartfx.server

Class TitleDockable

java.lang.Object

com.softwarefx.chartfx.server.Title

com.softwarefx.chartfx.server.TitleDockable

public class TitleDockable
extends Title

Provides access to the TitleDockable object, and allows customization of the Titles of the chart.

The TitleDockable provides the developer with a means of controlling positioning and alignment for configured titles in a chart as well as visual attributes.

Using the supported members, you can adjust title strings to be center, near and fear as well as dock them in the right, left, top, or bottom of the chart.

To dock a title or use line alignment attributes, chart title objects must be created as a TitleDockable rather than a general Titleobject.

• Java

• TitleDockable title;
  title = new TitleDockable();
  title.Text = "Most Populated South American Countries";
  chart1.getTitles().add(title);
  title = new TitleDockable();
  title.setDock(DockArea.BOTTOM);
  title.setTextColor(new java.awt.Color(0,128,0,255));
  title.setAlignment(StringAlignment.FAR);
  title.setText("Source: Wikipedia @2013");
  chart1.getTitles().add(title);
  PopulateSouthAmericaPopulation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getLegendBox().setVisible(false);
  

  public static void PopulateSouthAmericaPopulation(Chart chart1) {
      SouthAmericaPopulation[] data = new SouthAmericaPopulation[]{
          new SouthAmericaPopulation("Brazil", 201033000),
          new SouthAmericaPopulation("Colombia", 47130000),
          new SouthAmericaPopulation("Argentina", 41350000),
          new SouthAmericaPopulation("Peru", 30476000),
          new SouthAmericaPopulation("Venezuela", 29760000),
          new SouthAmericaPopulation("Chile", 16841000),
          new SouthAmericaPopulation("Ecuador", 15779000),
          new SouthAmericaPopulation("Bolivia", 10517000)
      };
      ObjectProvider objProvider = new ObjectProvider(data);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  }
  

  public static class Countries {
  
      public Countries(String country, double lei, double gdppc, java.awt.Image flag) {
          this.setCountry(country);
          this.setLEI(lei);
          this.setGDPPC(gdppc);
          this.setFlag(flag);
      }
      private String privateCountry;
  
      public final String getCountry() {
          return privateCountry;
      }
  
      public final void setCountry(String value) {
          privateCountry = value;
      }
      private double privateLEI;
  
      public final double getLEI() {
          return privateLEI;
      }
  
      public final void setLEI(double value) {
          privateLEI = value;
      }
      private double privateGDPPC;
  
      public final double getGDPPC() {
          return privateGDPPC;
      }
  
      public final void setGDPPC(double value) {
          privateGDPPC = value;
      }
      private java.awt.Image privateFlag;
  
      public final java.awt.Image getFlag() {
          return privateFlag;
      }
  
      public final void setFlag(java.awt.Image value) {
          privateFlag = value;
      }
  }
  

  public static class SouthAmericaPopulation {
  
      public SouthAmericaPopulation(String country, double population) {
          this.setCountry(country);
          this.setPopulation(population);
      }
      private String privateCountry;
  
      public final String getCountry() {
          return privateCountry;
      }
  
      public final void setCountry(String value) {
          privateCountry = value;
      }
      private double privatePopulation;
  
      public final double getPopulation() {
          return privatePopulation;
      }
  
      public final void setPopulation(double value) {
          privatePopulation = value;
      }
  }
  

Constructor Summary

Constructors

Constructor and Description
TitleDockable() Constructs a newly allocated TitleDockable object
TitleDockable(java.lang.String text) Constructs a newly allocated TitleDockable object

Method Summary

Methods

Modifier and Type	Method and Description
DockArea	getDock() Sets or Gets the Dock property, which sets the position where the title will be docked.
boolean	isPlotAreaOnly() Gets or sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.
void	resetPlotAreaOnly() Set the property PlotAreaOnly to its default value.
void	setDock(DockArea value) Sets or Gets the Dock property, which Sets the position where the title will be docked.
void	setPlotAreaOnly(boolean value) Gets or sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.

Methods inherited from class com.softwarefx.chartfx.server.Title

getAlignment, getBackColor, getFont, getIndentation, getLineAlignment, getLink, getSeparation, getText, getTextColor, isRichText, resetAdditionalFontSize, resetAlignment, resetBackColor, resetDock, resetFlags, resetFont, resetIndentation, resetLineAlignment, resetRichText, resetSeparation, resetText, resetTextColor, setAlignment, setBackColor, setFont, setIndentation, setLineAlignment, setRichText, setSeparation, setText, setTextColor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TitleDockable

public TitleDockable()

Constructs a newly allocated TitleDockable object

TitleDockable

public TitleDockable(java.lang.String text)

Constructs a newly allocated TitleDockable object

Parameters:

text -

Method Detail

getDock

public DockArea getDock()

Sets or Gets the Dock property, which sets the position where the title will be docked.

This method allows you to dock the chart title at the top, bottom, left or right of the chart.

Below is a title located at the top of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.TOP);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

Alternatively, this is a title located at the right of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.RIGHT);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

This is a title located at the left of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.LEFT);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

Finally, this is a title located at the bottom of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.BOTTOM);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

setDock

public void setDock(DockArea value)

Sets or Gets the Dock property, which Sets the position where the title will be docked.

This method allows you to dock the chart title at the top, bottom, left or right of the chart.

Below is a title located at the top of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.TOP);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

Alternatively, this is a title located at the right of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.RIGHT);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

This is a title located at the left of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.LEFT);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

Finally, this is a title located at the bottom of the chart:

• Java

• PopulateBirthVariation(chart1);
  chart1.setGallery(Gallery.BAR);
  chart1.getAxisY().getTitle().setText("Percentage");
  TitleDockable td;
  td = new TitleDockable("Birth Variation by Gender");
  td.setDock(DockArea.BOTTOM);
  chart1.getTitles().add(td);
  

  public static void PopulateBirthVariation(Chart chart1) {
      BirthVariation[] variations = new BirthVariation[] {
          new BirthVariation("2007", 4.5, 4.9 ),
          new BirthVariation("2008", -1.8, 1.2 ),
          new BirthVariation("2009", 2.3, -2.6 ),
          new BirthVariation("2010", 2.0, 3.0),
          new BirthVariation("2011", -0.5, -1.7 ),
          new BirthVariation("2012", 3.1, -0.9 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(variations);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  
  }
  

  public static class BirthVariation {
  
      public BirthVariation(String year, double male, double female) {
          this.setYear(year);
          this.setMale(male);
          this.setFemale(female);
      }
      private String privateYear;
  
      public final String getYear() {
          return privateYear;
      }
  
      public final void setYear(String value) {
          privateYear = value;
      }
      private double privateMale;
  
      public final double getMale() {
          return privateMale;
      }
  
      public final void setMale(double value) {
          privateMale = value;
      }
      private double privateFemale;
  
      public final double getFemale() {
          return privateFemale;
      }
  
      public final void setFemale(double value) {
          privateFemale = value;
      }
  }
  

Parameters:

value -

isPlotAreaOnly

public boolean isPlotAreaOnly()

Gets or sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.

When set to True, the title header is the same width as the chart's plot area. When set to False, title may be drawn across the entire chart including margins.

When using the setAlignment method, the isPlotAreaOnly method will affect the position of the text when configured to Near or Far.

To set the Title isPlotAreaOnly method to false:

• Java

• TitleDockable title;
  title = new TitleDockable();
  title.setText("Very looooooooooooooonnnng Title");
  title.setPlotAreaOnly(false);
  chart1.getTitles().add(title);
  

See Also:

resetPlotAreaOnly

setPlotAreaOnly

public void setPlotAreaOnly(boolean value)

Gets or sets a value indicating whether the title may use the entire length of the chart, or only above the plot area.

When set to True, the title header is the same width as the chart's plot area. When set to False, title may be drawn across the entire chart including margins.

When using the setAlignment method, the isPlotAreaOnly method will affect the position of the text when configured to Near or Far.

To set the Title isPlotAreaOnly method to false:

• Java

• TitleDockable title;
  title = new TitleDockable();
  title.setText("Very looooooooooooooonnnng Title");
  title.setPlotAreaOnly(false);
  chart1.getTitles().add(title);
  

Parameters:

value -

See Also:

resetPlotAreaOnly

resetPlotAreaOnly

public void resetPlotAreaOnly()

Set the property PlotAreaOnly to its default value.

See Also:

isPlotAreaOnly