ptolemy.actor.lib.gui

Interface PlotterBaseInterface

All Known Implementing Classes:

PlotterBaseJavaSE

public interface PlotterBaseInterface

Interface encapsulating platform dependent code of the PlotterBase from the platform independent parts.

Since:

Ptolemy II 10.0

Version:

$Id: PlotterBaseInterface.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Anar Huseynov

Accepted Rating:

Red (ahuseyno)

Proposed Rating:

Red (ahuseyno)

Method Summary

Modifier and Type	Method and Description
void	bringToFront() Bring the plotter frame to the front.
void	cleanUp() Free up memory when closing.
java.lang.Object	getFrame() Get the plotter's frame.
java.lang.Object	getPlatformContainer() Get the platform dependent container that contains the plotter.
java.lang.Object	getTableau() Get the plotter tableau.
void	init(PlotterBase plotterBase) Initialize the implementation.
void	initializeEffigy() Initialize the effigy of the plotter.
void	initWindowAndSizeProperties() Initialize window and size attributes.
PlotBoxInterface	newPlot() Create a new instance of the PlotBoxInterface implementation.
void	remove() Remove the plot from the current container, if there is one.
void	removeNullContainer() Remove the plot from the frame if the container is null.
void	setFrame(java.lang.Object frame) Set the frame of the plotter.
void	setPlatformContainer(java.lang.Object container) Set the platform dependent container of the plotter.
void	setTableauTitle(java.lang.String title) Set the title of the tableau.
void	updateSize() Update size attribute of the plotter.
void	updateWindowAndSizeAttributes() Update values of the attributes.

Method Detail

cleanUp

void cleanUp()

Free up memory when closing.

bringToFront

void bringToFront()

Bring the plotter frame to the front.

getFrame

java.lang.Object getFrame()

Get the plotter's frame.

Returns:

the plotter's frame.

See Also:

setFrame(Object)

getPlatformContainer

java.lang.Object getPlatformContainer()

Get the platform dependent container that contains the plotter.

Returns:

the platform dependent container.

See Also:

setPlatformContainer(Object)

getTableau

java.lang.Object getTableau()

Get the plotter tableau.

Returns:

the plotter tableau.

init

void init(PlotterBase plotterBase)

Initialize the implementation.

Parameters:

plotterBase - the instance that created the implementation.

initializeEffigy

void initializeEffigy()
               throws IllegalActionException

Initialize the effigy of the plotter.

Throws:

IllegalActionException - If there is a problem initializing the effigy

initWindowAndSizeProperties

void initWindowAndSizeProperties()
                          throws IllegalActionException,
                                 NameDuplicationException

Initialize window and size attributes.

Throws:

IllegalActionException - if there is a problem creating the attributes.

NameDuplicationException - if there is a problem creating the attributes.

newPlot

PlotBoxInterface newPlot()

Create a new instance of the PlotBoxInterface implementation.

Returns:

a new instance of the PlotBoxInterface implementation.

remove

void remove()

Remove the plot from the current container, if there is one.

removeNullContainer

void removeNullContainer()

Remove the plot from the frame if the container is null.

setFrame

void setFrame(java.lang.Object frame)

Set the frame of the plotter.

Parameters:

frame - The frame to set.

See Also:

getFrame()

setTableauTitle

void setTableauTitle(java.lang.String title)

Set the title of the tableau.

Parameters:

title - the title to set.

setPlatformContainer

void setPlatformContainer(java.lang.Object container)

Set the platform dependent container of the plotter. The container can be AWT container or Android view.

Parameters:

container - the platform dependent container.

See Also:

getPlatformContainer()

updateSize

void updateSize()

Update size attribute of the plotter.

updateWindowAndSizeAttributes

void updateWindowAndSizeAttributes()

Update values of the attributes.