com.steema.teechart
Class Panel

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.Shape
          extended by com.steema.teechart.Panel

public class Panel
extends Shape

Title: Panel class.

Description: Chart background panel characteristics

Copyright (c) 2005-2013 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Field Summary
static Color defaultColor
           
protected  Graphics3D internalCanvas
           
 
Fields inherited from class com.steema.teechart.Shape
bBevel, bBorderRound, bBrush, bImageBevel, bTransparent, defaultVisible, pPen, shadow, shapeBounds, visible
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
Panel()
           
Panel(IBaseChart c)
           
 
Method Summary
 Rectangle applyMargins(Rectangle r)
          Applies panel margins.
 void backImageClear()
          Obsolete.
 Rectangle draw(IGraphics3D g, Rectangle r)
          Paints the Chart in your preferred Canvas and region.
 boolean getBackImageInside()
          Obsolete.
 ChartPen getBorderPen()
          Obsolete.
 double getMarginBottom()
          Bottom margin expressed as percentage of Chart Drawing.
 double getMarginLeft()
          Left margin expressed as percentage of Chart Drawing.
 double getMarginRight()
          Right margin expressed as percentage of Chart Drawing.
 double getMarginTop()
          Top margin expressed as percentage of Chart Drawing.
 PanelMarginUnits getMarginUnits()
          The units in which the Margins are expressed.
 boolean getVisible()
          Shows or hides the Panel.
 void setBackImageInside(boolean value)
          Obsolete.
 void setMarginBottom(double value)
          Sets Bottom margin as percentage of Chart Drawing.
 void setMarginLeft(double value)
          Sets Left margin as percentage of Chart Drawing.
 void setMarginRight(double value)
          Sets Right margin as percentage of Chart Drawing.
 void setMarginTop(double value)
          Sets Top margin as percentage of Chart Drawing.
 void setMarginUnits(PanelMarginUnits value)
          Sets the units in which the Margins are expressed.
 void setTransparent(boolean value)
          Enables/disables transparency of shape.
 void setVisible(boolean value)
          Shows or hides the Panel.
 
Methods inherited from class com.steema.teechart.Shape
assign, getBevel, getBevelInner, getBevelOuter, getBevelWidth, getBorderRound, getBottom, getBrush, getColor, getGradient, getHeight, getImage, getImageBevel, getImageMode, getImageTransparent, getLeft, getPen, getRight, getShadow, getShapeBounds, getTop, getTransparency, getTransparent, getWidth, paint, setBevel, setBevelInner, setBevelOuter, setBevelWidth, setBorderRound, setBottom, setBrush, setChart, setColor, setDefaultVisible, setHeight, setImage, setImageMode, setImageTransparent, setLeft, setPen, setRight, setShapeBounds, setTop, setTransparency, setWidth
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

internalCanvas

protected Graphics3D internalCanvas

defaultColor

public static final Color defaultColor
Constructor Detail

Panel

public Panel(IBaseChart c)

Panel

public Panel()
Method Detail

getBorderPen

public ChartPen getBorderPen()
Obsolete. Please use the Pen method instead.

Returns:
ChartPen

getVisible

public boolean getVisible()
Shows or hides the Panel.

Overrides:
getVisible in class Shape
Returns:
boolean

setVisible

public void setVisible(boolean value)
Shows or hides the Panel.

Overrides:
setVisible in class Shape
Parameters:
value - boolean

setTransparent

public void setTransparent(boolean value)
Description copied from class: Shape
Enables/disables transparency of shape.

Overrides:
setTransparent in class Shape
Parameters:
value - boolean

draw

public Rectangle draw(IGraphics3D g,
                      Rectangle r)
Paints the Chart in your preferred Canvas and region.

Parameters:
g - IGraphics3D
r - Rectangle
Returns:
Rectangle

applyMargins

public Rectangle applyMargins(Rectangle r)
Applies panel margins.

Parameters:
r -
Returns:

backImageClear

public void backImageClear()
Obsolete. Please Set Panel.Image=null.


getMarginUnits

public PanelMarginUnits getMarginUnits()
The units in which the Margins are expressed.
Either as a percentage of the pixel height and width of the Chart Drawing Canvas, or in pixels from the panel borders.
Default value: Percent

Returns:
PanelMarginUnits

setMarginUnits

public void setMarginUnits(PanelMarginUnits value)
Sets the units in which the Margins are expressed.
Default value: Percent

Parameters:
value - PanelMarginUnits

getMarginLeft

public double getMarginLeft()
Left margin expressed as percentage of Chart Drawing.
Each Chart.Panel class has four margin parameters: LeftMargin, RightMargin, TopMargin, BottomMargin. These properties are expressed as a percentage of the pixel height (for top and bottom margins) and width (for left and right margins) of the Chart Drawing Canvas. Default values are 8 for top and bottom margins and 12 for left and right margins. Or they can be expressed in pixels by changing the MarginUnits from percentage (default) to pixels.
Default value: 12

Returns:
double

setMarginLeft

public void setMarginLeft(double value)
Sets Left margin as percentage of Chart Drawing.
Default value: 12

Parameters:
value - double
See Also:
getMarginLeft()

getMarginTop

public double getMarginTop()
Top margin expressed as percentage of Chart Drawing.
Each Chart.Panel class has four margin properties: LeftMargin, RightMargin, TopMargin, BottomMargin. These properties are expressed as a percentage of the pixel height (for top and bottom margins) and width (for left and right margins) of the Chart Drawing Canvas. Default values are 8 for top and bottom margins and 12 for left and right margins. Or they can be expressed in pixels by changing the MarginUnits from percentage (default) to pixels.
Default value: 8

Returns:
double

setMarginTop

public void setMarginTop(double value)
Sets Top margin as percentage of Chart Drawing.
Default value: 8

Parameters:
value - double
See Also:
getMarginTop()

getMarginRight

public double getMarginRight()
Right margin expressed as percentage of Chart Drawing.
Each Chart.Panel class has four margin properties: LeftMargin, RightMargin, TopMargin, BottomMargin. These properties are expressed as a percentage of the pixel height (for top and bottom margins) and width (for left and right margins) of the Chart Drawing Canvas. Default values are 8 for top and bottom margins and 12 for left and right margins. Or they can be expressed in pixels by changing the MarginUnits from percentage (default) to pixels.
Default value: 12

Returns:
double

setMarginRight

public void setMarginRight(double value)
Sets Right margin as percentage of Chart Drawing.
Default value: 12

Parameters:
value - double
See Also:
getMarginRight()

getMarginBottom

public double getMarginBottom()
Bottom margin expressed as percentage of Chart Drawing.
Each Chart.Panel class has four margin properties: LeftMargin, RightMargin, TopMargin, BottomMargin. These properties are expressed as a percentage of the pixel height (for top and bottom margins) and width (for left and right margins) of the Chart Drawing Canvas. Default values are 8 for top and bottom margins and 12 for left and right margins. Or they can be expressed in pixels by changing the MarginUnits from percentage (default) to pixels.
Default value: 8

Returns:
double

setMarginBottom

public void setMarginBottom(double value)
Sets Bottom margin as percentage of Chart Drawing.
Default value: 8

Parameters:
value - double
See Also:
getMarginBottom()

getBackImageInside

public boolean getBackImageInside()
Obsolete. Please use Walls.Back.Image instead.

Returns:
boolean

setBackImageInside

public void setBackImageInside(boolean value)
Obsolete. Please use Walls.Back.Image instead.

Parameters:
value - boolean