caviargui
Class FrameData

java.lang.Object
  |
  +--caviargui.FrameData

public class FrameData

extends java.lang.Object

Class for representing all boxes so they can be scrolled through without reading them from disk

Field Summary

protected static int	GROUP_BOXES Constants used to represent the number of single or group boxes contained in a FrameData object.
protected caviargui.GroupBox[]	groupBox Structures used for storing group box data about the video frame.
protected static int	SINGLE_BOXES Constants used to represent the number of single or group boxes contained in a FrameData object.
protected caviargui.SingleBox[]	singleBox Structures used for storing single box data about the video frame.

Constructor Summary

FrameData()
Default constructor sets all the data to nothing.

FrameData(caviargui.SingleBox[] singleBox, caviargui.GroupBox[] groupBox)
Constructor specifying the single boxes and the group boxes to be used for this FrameData object.

Method Summary

caviargui.GroupBox	getGroupBox(int i) Returns the GroupBox object at index i in this FrameData object.
caviargui.GroupBox[]	getGroupBoxes() Returns the array of all GroupBox objects in this FrameData object.
int	getSelected() Returns the currently selected box, 0-6 (currently) represent the 7 single boxes and 7-13 represent the 7 group boxes.
caviargui.SingleBox	getSingleBox(int i) Returns the SingleBox object at index i in this FrameData object.
caviargui.SingleBox[]	getSingleBoxes() Returns the array of all SingleBox objects in this FrameData object.
java.lang.String	toString() Returns the String representation of this FrameData object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GROUP_BOXES

protected static final int GROUP_BOXES

Constants used to represent the number of single or group boxes contained in a FrameData object.

See Also:

Constant Field Values

SINGLE_BOXES

protected static final int SINGLE_BOXES

Constants used to represent the number of single or group boxes contained in a FrameData object.

See Also:

Constant Field Values

singleBox

protected caviargui.SingleBox[] singleBox

Structures used for storing single box data about the video frame.

groupBox

protected caviargui.GroupBox[] groupBox

Structures used for storing group box data about the video frame.

Constructor Detail

FrameData

public FrameData()

Default constructor sets all the data to nothing.

FrameData

public FrameData(caviargui.SingleBox[] singleBox,
                 caviargui.GroupBox[] groupBox)

Constructor specifying the single boxes and the group boxes to be used for this FrameData object.

Method Detail

getSelected

public int getSelected()

Returns the currently selected box, 0-6 (currently) represent the 7 single boxes and 7-13 represent the 7 group boxes.

getSingleBox

public caviargui.SingleBox getSingleBox(int i)

Returns the SingleBox object at index i in this FrameData object.

getSingleBoxes

public caviargui.SingleBox[] getSingleBoxes()

Returns the array of all SingleBox objects in this FrameData object.

getGroupBox

public caviargui.GroupBox getGroupBox(int i)

Returns the GroupBox object at index i in this FrameData object.

getGroupBoxes

public caviargui.GroupBox[] getGroupBoxes()

Returns the array of all GroupBox objects in this FrameData object.

toString

public java.lang.String toString()

Returns the String representation of this FrameData object.

Overrides:

toString in class java.lang.Object