com.softwarefx.chartfx.server.adornments

Class SimpleBorder

java.lang.Object

com.softwarefx.chartfx.server.adornments.SimpleBorder

All Implemented Interfaces:

IBorderAdornment

public final class SimpleBorder
extends java.lang.Object
implements IBorderAdornment

Provides access to the SimpleBorder object.

Use the SimpleBorder's methods to configure the Border of the Chart, as well as the setBorder of the DockableBar such as the DataGrid,the LegendBox, or the setToolBar.

The following image shows a red SimpleBorder with a "Bump" effect around the chart.

• image
• Java

• 

• PopulateCarProduction(chart1);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  SimpleBorder border;
  border = new SimpleBorder(SimpleBorderType.BUMP);
  border.setColor(new java.awt.Color(255,0,0,255));
  chart1.setChartBorder(border);
  chart1.getLegendBox().setVisible(true);
  chart1.getLegendBox().setBorder(DockBorder.INTERNAL);
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

Please see the setType method for a complete list of the supported SimpleBorder types.

Note: To set the basic border of a chart in your applications, you must reference Adornments in your project.

If your looking for the graphical image borders, please refer to the VectorBorder and ImageBorder classes.

Constructor Summary

Constructors

Constructor and Description
SimpleBorder() Constructs a newly allocated SimpleBorder object
SimpleBorder(SimpleBorderType type) Constructs a newly allocated SimpleBorder object
SimpleBorder(SimpleBorderType type, java.awt.Color clr) Constructs a newly allocated SimpleBorder object

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getColor() Sets the color of the border.
SimpleBorderType	getType() Gets or sets the type of the Simple border object.
boolean	isInternalOpposite() Sets the internal tool borders opposite of the configured default border when present.
void	resetColor() Set the property Color to its default value.
void	resetInternalOpposite() Set the property InternalOpposite to its default value.
void	resetType() Set the property Type to its default value.
void	setColor(java.awt.Color value) Sets the color of the border.
void	setInternalOpposite(boolean value) Sets the internal tool borders opposite of the configured default border when present.
void	setType(SimpleBorderType value) Gets or sets the type of the Simple border object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleBorder

public SimpleBorder()

Constructs a newly allocated SimpleBorder object

SimpleBorder

public SimpleBorder(SimpleBorderType type)

Constructs a newly allocated SimpleBorder object

Parameters:

type -

SimpleBorder

public SimpleBorder(SimpleBorderType type,
            java.awt.Color clr)

Constructs a newly allocated SimpleBorder object

Parameters:

type -

clr -

Method Detail

getColor

public java.awt.Color getColor()

Sets the color of the border.

• Not all SimpleBorders have a outlining border to use this method. If there is not a border, the color assignment will have no effect.
• For more information regarding the Color type, please refer to the Documentation.
• Here is an example of the "Raised" SimpleBorder with the border color turned to red:

• Java

• PopulateCarProduction(chart1);
  SimpleBorder myBorder;
  myBorder = new SimpleBorder(SimpleBorderType.RAISED);
  myBorder.setColor(new java.awt.Color(255,0,0,255));
  chart1.setChartBorder(myBorder);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

Specified by:

getColor in interface IBorderAdornment

See Also:

resetColor

setColor

public void setColor(java.awt.Color value)

Sets the color of the border.

• Not all SimpleBorders have a outlining border to use this method. If there is not a border, the color assignment will have no effect.
• For more information regarding the Color type, please refer to the Documentation.
• Here is an example of the "Raised" SimpleBorder with the border color turned to red:

• Java

• PopulateCarProduction(chart1);
  SimpleBorder myBorder;
  myBorder = new SimpleBorder(SimpleBorderType.RAISED);
  myBorder.setColor(new java.awt.Color(255,0,0,255));
  chart1.setChartBorder(myBorder);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

Specified by:

setColor in interface IBorderAdornment

Parameters:

value -

See Also:

resetColor

isInternalOpposite

public boolean isInternalOpposite()

Sets the internal tool borders opposite of the configured default border when present.

• Java

• PopulateCarProduction(chart1);
  SimpleBorder myBorder;
  myBorder = new SimpleBorder(SimpleBorderType.RAISED);
  myBorder.setInternalOpposite(true);
  chart1.setChartBorder(myBorder);
  chart1.getLegendBox().setBorder(DockBorder.INTERNAL);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

• Java

• PopulateCarProduction(chart1);
  SimpleBorder myBorder;
  myBorder = new SimpleBorder(SimpleBorderType.RAISED);
  myBorder.setInternalOpposite(false);
  chart1.setChartBorder(myBorder);
  chart1.getLegendBox().setBorder(DockBorder.INTERNAL);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

See Also:

resetInternalOpposite

setInternalOpposite

public void setInternalOpposite(boolean value)

Sets the internal tool borders opposite of the configured default border when present.

• Java

• PopulateCarProduction(chart1);
  SimpleBorder myBorder;
  myBorder = new SimpleBorder(SimpleBorderType.RAISED);
  myBorder.setInternalOpposite(true);
  chart1.setChartBorder(myBorder);
  chart1.getLegendBox().setBorder(DockBorder.INTERNAL);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

• Java

• PopulateCarProduction(chart1);
  SimpleBorder myBorder;
  myBorder = new SimpleBorder(SimpleBorderType.RAISED);
  myBorder.setInternalOpposite(false);
  chart1.setChartBorder(myBorder);
  chart1.getLegendBox().setBorder(DockBorder.INTERNAL);
  chart1.getTitles().add(new TitleDockable("Vehicles Production by Type"));
  

  public static void PopulateCarProduction(Chart chart1) {
      CarProduction[] production = new CarProduction[] {
          new CarProduction("Jan", 1760, 535, 695 ) ,
          new CarProduction("Feb", 1849, 395, 688 ) ,
          new CarProduction("Mar", 2831, 685, 1047 ) ,
          new CarProduction("Apr", 2851, 984, 1652 ) ,
          new CarProduction("May", 2961, 1579, 1889 ) ,
          new CarProduction("Jun", 1519, 1539, 1766 ) ,
          new CarProduction("Jul", 2633, 1489, 1361 ) ,
          new CarProduction("Aug", 1140, 650, 874 ) ,
          new CarProduction("Sep", 1626, 653, 693 ) ,
          new CarProduction("Oct", 1478, 2236, 786 ) ,
          new CarProduction("Nov", 1306, 1937, 599 ) ,
          new CarProduction("Dec", 1607, 2138, 678 )
      };
  
      ObjectProvider objProvider = new ObjectProvider(production);
      chart1.getDataSourceSettings().setDataSource(objProvider);
  
  }
  

  public static class CarProduction {
  
      private CarProduction(String month, int sedan, int coupe, int SUV) {
          this.setMonth(month);
          this.setSedan(sedan);
          this.setCoupe(coupe);
          this.setSUV(SUV);
      }
  
      private String privateMonth;
  
      public final String getMonth() {
          return privateMonth;
      }
  
      public final void setMonth(String value) {
          privateMonth = value;
      }
      private int privateSedan;
  
      public final int getSedan() {
          return privateSedan;
      }
  
      public final void setSedan(int value) {
          privateSedan = value;
      }
      private int privateCoupe;
  
      public final int getCoupe() {
          return privateCoupe;
      }
  
      public final void setCoupe(int value) {
          privateCoupe = value;
      }
      private int privateSUV;
  
      public final int getSUV() {
          return privateSUV;
      }
  
      public final void setSUV(int value) {
          privateSUV = value;
      }
  }
  

Parameters:

value -

See Also:

resetInternalOpposite

getType

public SimpleBorderType getType()

Gets or sets the type of the Simple border object.

Once you create the default border object, you may assign attributes to the object with the supported SimpleBorder methods.

Sets the "Bump" type simple border:

• Java

• SimpleBorder border;
  border = new SimpleBorder();
  border.setType(SimpleBorderType.BUMP);
  chart1.setChartBorder(border);
  

See Also:

resetType

setType

public void setType(SimpleBorderType value)

Gets or sets the type of the Simple border object.

Once you create the default border object, you may assign attributes to the object with the supported SimpleBorder methods.

Sets the "Bump" type simple border:

• Java

• SimpleBorder border;
  border = new SimpleBorder();
  border.setType(SimpleBorderType.BUMP);
  chart1.setChartBorder(border);
  

Parameters:

value -

See Also:

resetType

resetColor

public void resetColor()

Set the property Color to its default value.

See Also:

setColor

resetInternalOpposite

public void resetInternalOpposite()

Set the property InternalOpposite to its default value.

See Also:

isInternalOpposite

resetType

public void resetType()

Set the property Type to its default value.

See Also:

setType