jhplot
Class GHPanel

java.lang.Object
  extended by jhplot.GHPanel
All Implemented Interfaces:
ComponentListener, Serializable, EventListener
Direct Known Subclasses:
GHFrame

public class GHPanel
extends Object
implements ComponentListener, Serializable

Class to build the global panel with graphics. It should be inserted to some frame. It has 4 margins which can be obtained from this class.

See Also:
Serialized Form

Constructor Summary
GHPanel(int Width, int Height)
          Create a panel with graphics.
 
Method Summary
 void addComp(Component a)
          Add a component to the main panel
 void addGraph(int i1, int i2, Component a)
          Add a graph or any component in the location given by i1 and i2
 void componentHidden(ComponentEvent e)
           
 void componentMoved(ComponentEvent e)
           
 void componentResized(ComponentEvent e)
           
 void componentShown(ComponentEvent e)
           
static void disableDoubleBuffering(Component c)
           
static void enableDoubleBuffering(Component c)
           
 void export(String file)
          Fast export of the canvas to an image file (depends on the extension, i.e.
 void exportDialog(String file)
          Export a GHFrame image to an external file: The file extension is very important: *.png - make PNG figure *.eps - make EPS figure *.ps - make PS figure *.jpg - make JPG figure *.pdf - make PDF figure *.SVG - make SVG figure *.EMF - make EMF figure, It will open some dialog in case if the file exists
 void exportImage()
          Exports the image to some graphic format.
 JPanel getCanvasPanel()
          get JPanel for the main panel which keeps the central panel and all 4 margins
 Color getMarginBackground()
          Get color for all global margins
 JPanel getMarginPanelBottom()
          get JPanel for bottom margin
 JPanel getMarginPanelCenter()
          get JPanel for central with drawings
 JPanel getMarginPanelLeft()
          get JPanel for left margin
 JPanel getMarginPanelRight()
          get JPanel for right margin
 JPanel getMarginPanelTop()
          get JPanel for top margin
 double getMarginSizeBottom()
          Get size of the bottom margin as ratio to the main panel
 double getMarginSizeLeft()
          Get the size of left margin terms of the ratio to the main panel
 double getMarginSizeRight()
          Get the size of right margin of the global canvas in terms of the ratio to thye global canvas
 double getMarginSizeTop()
          Get size of the top margin of global canvas in terms of ratio to the main panel
 int getSizeX()
          Get the width of the main panel which keeps all margins and the central panel (in pixels)
 int getSizeY()
          Get the height of the main panel which keeps all margins and the central panel (in pixels)
 String getTextBottom()
          Get the text of bottom margin.
 Color getTextBottomColor()
          Get the color of bottom margin for the text.
 Color getTextBottomColorBack()
          Get the background color of bottom margin
 Font getTextBottomFont()
          Get the font of bottom margin.
 String getTextLeft()
          Get the text of left margin.
 Color getTextLeftColor()
          Get the color of bottom margin for the text.
 Color getTextLeftColorBack()
          Get the background color of left margin
 Font getTextLeftFont()
          Get the font of left margin.
 double getTextPosBottomX()
          Get the text position in X relative to widths for bottom margin
 double getTextPosBottomY()
          Get the text position in Y relative to widths for bottom margin
 double getTextPosLeftX()
          Get the text position in X relative to widths for left margin
 double getTextPosLeftY()
          Get the text position in Y relative to widths for left margin
 double getTextPosRightX()
          Get the text position in X relative to widths for right margin
 double getTextPosRightY()
          Get the text position in Y relative to widths for right margin
 double getTextPosTopX()
          Get the text position in X relative to widths for top margin
 double getTextPosTopY()
          Get the text position in Y relative to widths for top margin
 String getTextRight()
          Get text of right margin.
 Color getTextRightColor()
          Get the color of right margin for the text.
 Color getTextRightColorBack()
          Get the background color of right margin
 Font getTextRightFont()
          Get the font of right margin.
 int getTextRotationBottom()
          Get the text rotation for bottom margin
 int getTextRotationLeft()
          Get the text rotation for left margin
 int getTextRotationRight()
          Get the text rotation for right margin
 int getTextRotationTop()
          Get the text rotation for top margin
 String getTextTop()
          Get text of top margin (title).
 Color getTextTopColor()
          Get the color of top margin for the text.
 Color getTextTopColorBack()
          Get the background color of top margin
 Font getTextTopFont()
          Get the font of top margin
 boolean isBorderShown()
          is the boarder of margins shown?
 void printGraph()
          Print the canvas
 void resetMargins()
          Reset all margins to the default values.
 void setGTitle(String sname)
          Set the global title with default attributes.
 void setGTitle(String sname, Color c)
          Set the global title.
 void setGTitle(String sname, double space)
          Set the global title with default attributes.
 void setGTitle(String sname, Font f)
          Sets the global title using black color.
 void setGTitle(String sname, Font f, Color c)
          Sets the global title
 void setMarginBackground(Color backMargin)
          Set color for all global margins
 void setMarginSizeBottom(double bottomSize)
          Set size of the bottom margin of global canvas in terms of the ratio to the size of the main panel
 void setMarginSizeLeft(double leftSize)
          Set the size of left margin in term of the ratio to the global panel
 void setMarginSizeRight(double rightSize)
          Set the size of right margin of the global canvas in terms of the ration to the global panel in X
 void setMarginSizeTop(double topSize)
          Set size of the top margin of global canvas in terms of the ratio to the size of the main panel
 void setSizePanel(int Width, int Height)
          Set the size of the global panel which keeps the central panel and the margins
 void setTextBottom(String sname)
          Set the global bottom margin with default attributes.
 void setTextBottom(String sname, double space)
          Set the global bottom margin with default attributes.
 void setTextBottom(String sname, Font f)
          Sets a text on global bottom margin using black color.
 void setTextBottom(String sname, Font f, Color c)
          Sets a text on global bottom margin.
 void setTextBottomColorBack(Color c)
          Get the background color of bottom margin
 void setTextLeft(String sname)
          Set the global left margin with default attributes.
 void setTextLeft(String sname, double space)
          Set the global left margin with default attributes.
 void setTextLeft(String sname, Font f)
          Sets a text on global left margin using black color.
 void setTextLeft(String sname, Font f, Color c)
          Sets a text on global left margin
 void setTextLeftColorBack(Color c)
          Get the background color of left margin
 void setTextPosBottomX(double x)
          Set the text position in X relative to width for bottom margin
 void setTextPosBottomY(double y)
          Set the text position in Y relative to width for bottom margin
 void setTextPosLeftX(double x)
          Set the text position in X relative to width for left margin
 void setTextPosLeftY(double y)
          Set the text position in Y relative to width for left margin
 void setTextPosRightX(double x)
          Set the text position in X relative to width for right margin
 void setTextPosRightY(double y)
          Set the text position in Y relative to width for right margin
 void setTextPosTopX(double x)
          Set the text position in X relative to width for top margin
 void setTextPosTopY(double y)
          Set the text position in Y relative to width for top margin
 void setTextRight(String sname)
          Set the global right margin with default attributes.
 void setTextRight(String sname, double space)
          Set the global right margin with default attributes.
 void setTextRight(String sname, Font f)
          Sets a text on global right margin using black color.
 void setTextRight(String sname, Font f, Color c)
          Sets a text on global right margin
 void setTextRightColorBack(Color c)
          Get the background color of left margin
 void setTextRotationBottom(int r)
          Set the text rotation for bottom margin
 void setTextRotationLeft(int r)
          Set the text rotation for left margin
 void setTextRotationRight(int r)
          Set the text rotation for right margin
 void setTextRotationTop(int r)
          Set the text rotation for top margin
 void setTextTop(String sname)
          Set the global top margin with default attributes.
 void setTextTop(String sname, Font f)
          Sets a text on global top margin using black color.
 void setTextTop(String sname, Font f, Color c)
          Sets a text on global top margin
 void setTextTopColorBack(Color c)
          Get the background color of top margin
 void showBorders(boolean show)
          Show borders of margins for edditing
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GHPanel

public GHPanel(int Width,
               int Height)
Create a panel with graphics. By default, all margins have size of 10 pixels. Background color is white. Initialization of JHPLot classes are done here.

Parameters:
Width - in pixels
Height - in pixels
Method Detail

exportDialog

public void exportDialog(String file)
Export a GHFrame image to an external file: The file extension is very important: *.png - make PNG figure *.eps - make EPS figure *.ps - make PS figure *.jpg - make JPG figure *.pdf - make PDF figure *.SVG - make SVG figure *.EMF - make EMF figure, It will open some dialog in case if the file exists

Parameters:
file - name of the file with the image. Use appropriate extension for the file name for the export.

export

public void export(String file)
Fast export of the canvas to an image file (depends on the extension, i.e. PNG, PDF, EPS, PS). No questions will be asked, an existing file will be rewritten

Parameters:
file - Output file with the proper extension. If no extension, PNG file is assumed.

addGraph

public void addGraph(int i1,
                     int i2,
                     Component a)
Add a graph or any component in the location given by i1 and i2

Parameters:
i1 - location in x
i2 - location in y
a - component

setMarginBackground

public void setMarginBackground(Color backMargin)
Set color for all global margins

Parameters:
backMargin -

getMarginBackground

public Color getMarginBackground()
Get color for all global margins

Returns:
color color of the margins

addComp

public void addComp(Component a)
Add a component to the main panel

Parameters:
a - Component

getSizeX

public int getSizeX()
Get the width of the main panel which keeps all margins and the central panel (in pixels)

Returns:
size in X direction (width)

getSizeY

public int getSizeY()
Get the height of the main panel which keeps all margins and the central panel (in pixels)

Returns:
size in Y direction (height)

setGTitle

public void setGTitle(String sname,
                      Font f,
                      Color c)
Sets the global title

Parameters:
sname - Title
f - Font
c - Color

setTextTop

public void setTextTop(String sname,
                       Font f,
                       Color c)
Sets a text on global top margin

Parameters:
sname - Title
f - Font
c - Color

setTextLeft

public void setTextLeft(String sname,
                        Font f,
                        Color c)
Sets a text on global left margin

Parameters:
sname - Title
f - Font
c - Color

setTextRight

public void setTextRight(String sname,
                         Font f,
                         Color c)
Sets a text on global right margin

Parameters:
sname - Title
f - Font
c - Color

setTextBottom

public void setTextBottom(String sname,
                          Font f,
                          Color c)
Sets a text on global bottom margin.

Parameters:
sname - Title
f - Font
c - Color

getTextBottom

public String getTextBottom()
Get the text of bottom margin.

Returns:
Text

getTextBottomFont

public Font getTextBottomFont()
Get the font of bottom margin.

Returns:
Font

getTextBottomColor

public Color getTextBottomColor()
Get the color of bottom margin for the text.

Returns:
Color of text

getTextLeft

public String getTextLeft()
Get the text of left margin.

Returns:
Text

getTextLeftFont

public Font getTextLeftFont()
Get the font of left margin.

Returns:
Font

getTextLeftColor

public Color getTextLeftColor()
Get the color of bottom margin for the text.

Returns:
Color of text

getTextTop

public String getTextTop()
Get text of top margin (title).

Returns:
Text of the top margin

getTextTopFont

public Font getTextTopFont()
Get the font of top margin

Returns:
Font

getTextTopColor

public Color getTextTopColor()
Get the color of top margin for the text.

Returns:
Color

getTextRight

public String getTextRight()
Get text of right margin.

Returns:
text on the right panel

getTextRightFont

public Font getTextRightFont()
Get the font of right margin.

Returns:
Font of the right panel

getTextRightColor

public Color getTextRightColor()
Get the color of right margin for the text.

Returns:
Color

setGTitle

public void setGTitle(String sname,
                      Font f)
Sets the global title using black color.

Parameters:
sname - Title name
f - Font

setTextLeft

public void setTextLeft(String sname,
                        Font f)
Sets a text on global left margin using black color.

Parameters:
sname - Title
f - Font

setTextTop

public void setTextTop(String sname,
                       Font f)
Sets a text on global top margin using black color.

Parameters:
sname - Title
f - Font

setTextRight

public void setTextRight(String sname,
                         Font f)
Sets a text on global right margin using black color.

Parameters:
sname - Title
f - Font

setTextBottom

public void setTextBottom(String sname,
                          Font f)
Sets a text on global bottom margin using black color.

Parameters:
sname - Title
f - Font

setGTitle

public void setGTitle(String sname)
Set the global title with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 20)

Parameters:
sname - Title

setGTitle

public void setGTitle(String sname,
                      double space)
Set the global title with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 20)

Parameters:
sname - Title
space - size of the top margin (0-1)

setTextLeft

public void setTextLeft(String sname)
Set the global left margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title

setTextLeft

public void setTextLeft(String sname,
                        double space)
Set the global left margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title
space - size of the left margin (0-1)

setTextRight

public void setTextRight(String sname)
Set the global right margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title

setTextRight

public void setTextRight(String sname,
                         double space)
Set the global right margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title
space - size of the right margin (0-1)

setTextBottom

public void setTextBottom(String sname)
Set the global bottom margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title

setTextTop

public void setTextTop(String sname)
Set the global top margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title

resetMargins

public void resetMargins()
Reset all margins to the default values.


setTextBottom

public void setTextBottom(String sname,
                          double space)
Set the global bottom margin with default attributes. The default color is black. The default font is ("Lucida Sans", Font.BOLD, 18)

Parameters:
sname - Title
space - size of the bottom margin (0-1)

setGTitle

public void setGTitle(String sname,
                      Color c)
Set the global title. The default font is ("Lucida Sans", Font.BOLD, 20)

Parameters:
sname - Title
c - Color

getMarginPanelLeft

public JPanel getMarginPanelLeft()
get JPanel for left margin

Returns:
JPanel

getMarginPanelRight

public JPanel getMarginPanelRight()
get JPanel for right margin

Returns:
JPanel for right margin

getMarginPanelTop

public JPanel getMarginPanelTop()
get JPanel for top margin

Returns:
JPanel for top margin

getMarginPanelBottom

public JPanel getMarginPanelBottom()
get JPanel for bottom margin

Returns:
JPanel for bottom margin

getMarginPanelCenter

public JPanel getMarginPanelCenter()
get JPanel for central with drawings

Returns:
central JPanel

getCanvasPanel

public JPanel getCanvasPanel()
get JPanel for the main panel which keeps the central panel and all 4 margins

Returns:
JPanel Main panel

setTextRotationTop

public void setTextRotationTop(int r)
Set the text rotation for top margin

Parameters:
r - rotation (0, 90, -90)

getTextRotationTop

public int getTextRotationTop()
Get the text rotation for top margin

Returns:
rotation (0, 90, -90)

setTextRotationLeft

public void setTextRotationLeft(int r)
Set the text rotation for left margin

Parameters:
r - rotation (0, 90, -90)

getTextRotationLeft

public int getTextRotationLeft()
Get the text rotation for left margin

Returns:
rotation (0, 90, -90)

setTextRotationRight

public void setTextRotationRight(int r)
Set the text rotation for right margin

Parameters:
r - rotation (0, 90, -90)

getTextRotationRight

public int getTextRotationRight()
Get the text rotation for right margin

Returns:
rotation (0, 90, -90)

setTextRotationBottom

public void setTextRotationBottom(int r)
Set the text rotation for bottom margin

Parameters:
r - rotation (0, 90, -90)

getTextRotationBottom

public int getTextRotationBottom()
Get the text rotation for bottom margin

Returns:
rotation (0, 90, -90)

setTextPosTopX

public void setTextPosTopX(double x)
Set the text position in X relative to width for top margin

Parameters:
x - position of text in X (from 0 to 1)

setTextPosTopY

public void setTextPosTopY(double y)
Set the text position in Y relative to width for top margin

Parameters:
y - position of text in Y (from 0 to 1)

getTextPosTopX

public double getTextPosTopX()
Get the text position in X relative to widths for top margin

Returns:
position of text in X (from 0 to 1)

getTextPosTopY

public double getTextPosTopY()
Get the text position in Y relative to widths for top margin

Returns:
position of text in Y (from 0 to 1)

setTextPosLeftX

public void setTextPosLeftX(double x)
Set the text position in X relative to width for left margin

Parameters:
x - position of text in X (from 0 to 1)

setTextPosLeftY

public void setTextPosLeftY(double y)
Set the text position in Y relative to width for left margin

Parameters:
y - position of text in Y (from 0 to 1)

getTextPosLeftX

public double getTextPosLeftX()
Get the text position in X relative to widths for left margin

Returns:
position of text in X (from 0 to 1)

getTextPosLeftY

public double getTextPosLeftY()
Get the text position in Y relative to widths for left margin

Returns:
position of text in Y (from 0 to 1)

setTextPosRightX

public void setTextPosRightX(double x)
Set the text position in X relative to width for right margin

Parameters:
x - position of text in X (from 0 to 1)

setTextPosRightY

public void setTextPosRightY(double y)
Set the text position in Y relative to width for right margin

Parameters:
y - position of text in Y (from 0 to 1)

getTextPosRightX

public double getTextPosRightX()
Get the text position in X relative to widths for right margin

Returns:
position of text in X (from 0 to 1)

getTextPosRightY

public double getTextPosRightY()
Get the text position in Y relative to widths for right margin

Returns:
position of text in Y (from 0 to 1)

setTextPosBottomX

public void setTextPosBottomX(double x)
Set the text position in X relative to width for bottom margin

Parameters:
x - position of text in X (from 0 to 1)

setTextPosBottomY

public void setTextPosBottomY(double y)
Set the text position in Y relative to width for bottom margin

Parameters:
y - position of text in Y (from 0 to 1)

getTextPosBottomX

public double getTextPosBottomX()
Get the text position in X relative to widths for bottom margin

Returns:
position of text in X (from 0 to 1)

getTextPosBottomY

public double getTextPosBottomY()
Get the text position in Y relative to widths for bottom margin

Returns:
position of text in Y (from 0 to 1)

getTextBottomColorBack

public Color getTextBottomColorBack()
Get the background color of bottom margin

Returns:
Color

setTextBottomColorBack

public void setTextBottomColorBack(Color c)
Get the background color of bottom margin

Parameters:
c - Color

getTextTopColorBack

public Color getTextTopColorBack()
Get the background color of top margin

Returns:
Color

setTextTopColorBack

public void setTextTopColorBack(Color c)
Get the background color of top margin

Parameters:
c - Color

getTextLeftColorBack

public Color getTextLeftColorBack()
Get the background color of left margin

Returns:
Color

setTextLeftColorBack

public void setTextLeftColorBack(Color c)
Get the background color of left margin

Parameters:
c - Color

getTextRightColorBack

public Color getTextRightColorBack()
Get the background color of right margin

Returns:
Color

setTextRightColorBack

public void setTextRightColorBack(Color c)
Get the background color of left margin

Parameters:
c - Color

showBorders

public void showBorders(boolean show)
Show borders of margins for edditing

Parameters:
show - true if shown

isBorderShown

public boolean isBorderShown()
is the boarder of margins shown?

Returns:
true if shown.

exportImage

public void exportImage()
Exports the image to some graphic format.


printGraph

public void printGraph()
Print the canvas


setMarginSizeRight

public void setMarginSizeRight(double rightSize)
Set the size of right margin of the global canvas in terms of the ration to the global panel in X

Parameters:
rightSize - size of the right margin (from 0 to 1)

disableDoubleBuffering

public static void disableDoubleBuffering(Component c)

enableDoubleBuffering

public static void enableDoubleBuffering(Component c)

getMarginSizeRight

public double getMarginSizeRight()
Get the size of right margin of the global canvas in terms of the ratio to thye global canvas

Returns:
size of the margin from 0 to 1

setMarginSizeLeft

public void setMarginSizeLeft(double leftSize)
Set the size of left margin in term of the ratio to the global panel

Parameters:
leftSize - size of the margin from 0 to 1

getMarginSizeLeft

public double getMarginSizeLeft()
Get the size of left margin terms of the ratio to the main panel

Returns:
left margin size (from 0 to 1)

setMarginSizeBottom

public void setMarginSizeBottom(double bottomSize)
Set size of the bottom margin of global canvas in terms of the ratio to the size of the main panel

Parameters:
bottomSize - size of the bottom margin from 0 to 1

setMarginSizeTop

public void setMarginSizeTop(double topSize)
Set size of the top margin of global canvas in terms of the ratio to the size of the main panel

Parameters:
topSize - size of the top margin from 0 to 1

getMarginSizeBottom

public double getMarginSizeBottom()
Get size of the bottom margin as ratio to the main panel

Returns:
size of the bottom margin (from 0 to 1)

setSizePanel

public void setSizePanel(int Width,
                         int Height)
Set the size of the global panel which keeps the central panel and the margins

Parameters:
Width - Width
Height - Height

getMarginSizeTop

public double getMarginSizeTop()
Get size of the top margin of global canvas in terms of ratio to the main panel

Returns:
size of the top margin (from 0 to 1)

componentResized

public void componentResized(ComponentEvent e)
Specified by:
componentResized in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)
Specified by:
componentMoved in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)
Specified by:
componentShown in interface ComponentListener

componentHidden

public void componentHidden(ComponentEvent e)
Specified by:
componentHidden in interface ComponentListener


jHepWork 3.1 ©