Class Viewer.Presentation.ShutterList
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class Viewer.Presentation.ShutterList

Object
   |
   +----Viewer.Presentation.ShutterList

public class ShutterList
extends Object
This class manages the shutters of a presentation state. The data of the shutters are capsulated in a jDVPresentationState object. This class makes methods available for drawing the for handling shutters in a graphic context .

Author:
Klaus Kleber
Since:
30.04.1999

Variable Index

 o activeBitmapShutterIndex
Specifies the index of the current active bitmap shutter in the overlayIsShutterIndexList.
 o numberOfSuitableBitmapShutter
Contains the number of suitable bitmap shutters.
 o overlayIsShutterIndexList
Contains the index of every overlay which is suitable for use as a bitmap shutter.
 o overlayIsShutterLabelList
Contains the labels of every overlay which is suitable for use as a bitmap shutter.

Constructor Index

 o Viewer.Presentation.ShutterList(jDVPresentationState)
Constructs the ShutterList form the specified jDVPresentationState object.

Method Index

 o activateBitmapShutter(int)
Activates the bitmap shutter with the specified index in the overlayIsShutterIndexList.
 o addCircularShutter(int, int, int)
Sets and activates circular display shutter.
 o addPolygonalShutter(float[], int)
Sets and activates a polygonal display shutter.
 o addRectangularShutter(int, int, int, int)
Sets and activates rectangular display shutter.
 o buildShape()
Builds the shutterArea which is a combined Area of the vector shutters.
 o decativateBitmapShutter()
Deactivates the current bitmap shutter if exist.
 o delete(int)
Deactivates display shutter of given type.
 o deleteAll()
Deletes all objects.
 o deleteCircular()
Deletes a circular shutter if exist.
 o deletePolygonal()
Deletes a polygonal shutter if exist.
 o deleteRectangular()
Deletes a rectangular shutter if exist.
 o getGreyColorByte()
Returns a byte with the gray color value of the shutter.
 o getInfo()
Returns a String representing this object.
 o getShutterColorValue()
Converts the shutter presentation value in a value between 0 by 1 and returns this value.
 o getShutterPresentationValue()
Gets the shutter presentation value.
 o haveBitmapShutter()
Checks if a bitmapped shutter of given type is active.
 o haveCircularShutter()
Checks if a circular shutter of given type is active.
 o havePolygonalShutter()
Checks if a polygonal shutter of given type is active.
 o haveRectangularShutter()
Checks if a rectangular shutter of given type is active.
 o setClip(Graphics2D, AffineTransform)
Clips the specified Graphics2D object with the shutterArea.
 o setShutterColor(float)
Sets the shutter presentation value.

Variables

 o activeBitmapShutterIndex
public int activeBitmapShutterIndex
Specifies the index of the current active bitmap shutter in the overlayIsShutterIndexList. If no bitmap shutter is active the value is -1.

Since: 30.04.1999
 o numberOfSuitableBitmapShutter
public int numberOfSuitableBitmapShutter
Contains the number of suitable bitmap shutters.

Since: 30.04.1999
 o overlayIsShutterIndexList
public int[] overlayIsShutterIndexList
Contains the index of every overlay which is suitable for use as a bitmap shutter.

Since: 30.04.1999
 o overlayIsShutterLabelList
public java.lang.String[] overlayIsShutterLabelList
Contains the labels of every overlay which is suitable for use as a bitmap shutter. The index of the label is the same as the index in the overlayIsShutterIndexList.

Since: 30.04.1999

Constructors

 o ShutterList
public ShutterList(jDVPresentationState ps)
Constructs the ShutterList form the specified jDVPresentationState object.

Parameters:
ps - Contains the current jDVPresentationState object with the shutter data.
Since:
30.04.1999

Methods

 o activateBitmapShutter
public void activateBitmapShutter(int index)
Activates the bitmap shutter with the specified index in the overlayIsShutterIndexList.

Parameters:
index - Specifies the index of the new bitmap shutter in the overlayIsShutterIndexList. If index = -1 then the current shutter will be deactivate.
Since:
30.04.1999
 o addCircularShutter
public void addCircularShutter(int circX,
                               int circY,
                               int radius)
Sets and activates circular display shutter. If a bitmap shutter is exists, it is deactivated

Parameters:
circX - the X component of the shutter center
circY - the Y component of the shutter center
radius - the (horizontal) radius of the shutter
Since:
30.04.1999
 o addPolygonalShutter
public void addPolygonalShutter(float thePoints,
                                int numberOfPoints)
Sets and activates a polygonal display shutter. If a bitmap shutter is exists, it is deactivated

Parameters:
thePoints - Contains the points of the polyline shutter.
numberOfPoints - Number of points of the polyline shutter
Since:
30.04.1999
 o addRectangularShutter
public void addRectangularShutter(int lv,
                                  int rv,
                                  int uh,
                                  int lh)
Sets and activates rectangular display shutter. If a bitmap shutter is exists, it is deactivated

Parameters:
lv - the left vertical edge
rv - the right vertical edge
uh - the upper horizontal edge
lh - the lower horizontal edge
Since:
30.04.1999
 o buildShape
public void buildShape()
Builds the shutterArea which is a combined Area of the vector shutters.

Since:
30.04.1999
 o decativateBitmapShutter
public void decativateBitmapShutter()
Deactivates the current bitmap shutter if exist.

Since:
30.04.1999
 o delete
public void delete(int shutterValue)
Deactivates display shutter of given type.

Parameters:
shutterValue - the shutter type (from jDVPSShutterType).
Since:
30.04.1999
 o deleteAll
public void deleteAll()
Deletes all objects.

Since:
30.04.1999
 o deleteCircular
public void deleteCircular()
Deletes a circular shutter if exist.

Since:
30.04.1999
 o deletePolygonal
public void deletePolygonal()
Deletes a polygonal shutter if exist.

Since:
30.04.1999
 o deleteRectangular
public void deleteRectangular()
Deletes a rectangular shutter if exist.

Since:
30.04.1999
 o getGreyColorByte
public byte getGreyColorByte()
Returns a byte with the gray color value of the shutter. This value is transformed form the shutter presentation value. return The gray color value of the shutter.

Since:
30.04.1999
 o getInfo
public java.lang.String getInfo()
Returns a String representing this object.

Returns:
A String representing this object
Since:
30.04.1999
 o getShutterColorValue
public float getShutterColorValue()
Converts the shutter presentation value in a value between 0 by 1 and returns this value.

Returns:
A value between 0 by 1 which is the transformed shutter presentation value.
Since:
30.04.1999
 o getShutterPresentationValue
public int getShutterPresentationValue()
Gets the shutter presentation value. If no shutter display value exists, a default of 0 (black) is set.

Returns:
The shutter presentation value.
Since:
30.04.1999
 o haveBitmapShutter
public boolean haveBitmapShutter()
Checks if a bitmapped shutter of given type is active.

Returns:
true if this type of shutter is currently active.
Since:
30.04.1999
 o haveCircularShutter
public boolean haveCircularShutter()
Checks if a circular shutter of given type is active.

Returns:
true if this type of shutter is currently active.
Since:
30.04.1999
 o havePolygonalShutter
public boolean havePolygonalShutter()
Checks if a polygonal shutter of given type is active.

Returns:
true if this type of shutter is currently active.
Since:
30.04.1999
 o haveRectangularShutter
public boolean haveRectangularShutter()
Checks if a rectangular shutter of given type is active.

Returns:
true if this type of shutter is currently active.
Since:
30.04.1999
 o setClip
public void setClip(Graphics2D g2,
                    AffineTransform aff)
Clips the specified Graphics2D object with the shutterArea. The clipping area will be transform with the specified AffineTransform object.

Parameters:
g2 - Specifies the Graphics2D object which will be clipped.
aff - Specifies the transformation which will be used.
Since:
30.04.1999
 o setShutterColor
public void setShutterColor(float colorValue)
Sets the shutter presentation value. The input is a value between 0 by 1. This value will convert in a value between 0 and 0xffff.

Parameters:
colorValue - Contains the new color.
Since:
30.04.1999

All Packages  Class Hierarchy  This Package  Previous  Next  Index