Package ptolemy.actor.lib.image

Interface ImageDisplayInterface

All Known Subinterfaces:

ImageDisplayInterface

All Known Implementing Classes:

ImageDisplayJavaSE, ImageDisplayJavaSE

public interface ImageDisplayInterface

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

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Jianwu Wang

Pt.AcceptedRating:

Pt.ProposedRating:

Method Summary

Modifier and Type	Method	Description
void	cleanUp()	Free up memory when closing.
void	display(Token in)	Display the specified token.
java.awt.Color	getBackground()	Get the background.
java.lang.Object	getFrame()	Get the image's frame.
java.lang.Object	getPicture()	Get the platform dependent picture that contains the image.
java.lang.Object	getPlatformContainer()	Get the platform dependent container that contains the image.
java.lang.Object	getTableau()	Get the image tableau.
void	init(ImageDisplay imageDisplay)	Initialize an object.
void	initializeEffigy()	Initialize the effigy of the image.
void	initWindowAndSizeProperties()	Initialize window and size attributes.
void	placeContainer(java.awt.Container container)	Set the container to be placed.
void	setBackground(java.awt.Color background)	Set the background.
void	setFrame(java.lang.Object frame)	Set the frame of the image.
void	setPicture(java.lang.Object picture)	Set the platform dependent picture of the image.
void	setPlatformContainer(java.lang.Object container)	Set the platform dependent container of the image.

Method Detail

cleanUp

void cleanUp()

Free up memory when closing.

display

void display(Token in)
      throws IllegalActionException

Display the specified token.

Parameters:

in - The token to display

Throws:

IllegalActionException - If the input is not acceptable to the implementation.

getBackground

java.awt.Color getBackground()

Get the background.

Returns:

The background color.

See Also:

setBackground(Color)

getFrame

java.lang.Object getFrame()

Get the image's frame.

Returns:

the image's frame.

See Also:

setFrame(Object)

getPicture

java.lang.Object getPicture()

Get the platform dependent picture that contains the image.

Returns:

the platform dependent container.

See Also:

setPicture(Object)

getPlatformContainer

java.lang.Object getPlatformContainer()

Get the platform dependent container that contains the image.

Returns:

the platform dependent container.

See Also:

setPlatformContainer(Object)

getTableau

java.lang.Object getTableau()

Get the image tableau.

Returns:

the image tableau.

init

void init(ImageDisplay imageDisplay)
   throws IllegalActionException,
          NameDuplicationException

Initialize an object. Derived classes should include class-specific initialization here.

Parameters:

imageDisplay - The object to be initialized

Throws:

IllegalActionException - If the entity cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

initializeEffigy

void initializeEffigy()
               throws IllegalActionException

Initialize the effigy of the image.

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.

placeContainer

void placeContainer(java.awt.Container container)

Set the container to be placed.

Parameters:

container - The Container to be placed.

setBackground

void setBackground(java.awt.Color background)

Set the background.

Parameters:

background - The background color.

See Also:

getBackground()

setFrame

void setFrame(java.lang.Object frame)

Set the frame of the image.

Parameters:

frame - The frame to set.

See Also:

getFrame()

setPicture

void setPicture(java.lang.Object picture)

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

Parameters:

picture - The picture

See Also:

getPicture()

setPlatformContainer

void setPlatformContainer(java.lang.Object container)

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

Parameters:

container - the platform dependent container.

See Also:

getPlatformContainer()