Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.huguesjohnson.tiamat
Class SequenceFrame

    java.lang.Object
      com.huguesjohnson.tiamat.SequenceFrame

All Implemented Interfaces:
  Storable

    public class SequenceFrame

extends java.lang.Object
implements Storable

SequenceFrame.java - class to represent a frame in a sequence

Author:
  Hugues Johnson

Field Summary
`protected java.lang.String` | `absoluteDir`

Constructor Summary
`SequenceFrame()` Creates a new instance of SequenceFrame.
`SequenceFrame(java.lang.String text, java.lang.String absoluteDir, java.lang.String bgImagePath, java.lang.String bgMusicPath)` Creates a new instance of SequenceFrame.

Method Summary
`java.awt.image.BufferedImage` | `getBgImage()` Returns the background image for this frame.
`java.lang.String` | `getBgImagePath()` Returns the relative path to the background image.
`java.lang.String` | `getBgImagePathAbsolute()` Returns the absolute path to the background image.
`java.lang.String` | `getBgMusicPath()` Returns the relative path to the background music.
`java.lang.String` | `getBgMusicPathAbsolute()` Returns the absolute path to the background music.
`java.lang.String` | `getText()` Returns the text to draw in this frame.
`void` | `onDeserialize(Formatter formatter, java.lang.String absoluteDir)` The onDeserialize event should be fired after an object is de-serialized.
`void` | `setAbsoluteDir(java.lang.String absoluteDir)` Sets the absolute path to the directory where images and background music are stored.
`void` | `setBgImagePath(java.lang.String bgImagePath)` Sets the relative path to the background image.
`void` | `setBgMusicPath(java.lang.String bgMusicPath)` Sets the relative path to the background music.
`void` | `setText(java.lang.String text)` Set the text to draw in this frame.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### absoluteDir

    protected transient java.lang.String absoluteDir

Constructor Detail

### SequenceFrame

    public SequenceFrame()

  Creates a new instance of SequenceFrame.

### SequenceFrame

    public SequenceFrame(java.lang.String text,
                         java.lang.String absoluteDir,
                         java.lang.String bgImagePath,
                         java.lang.String bgMusicPath)

  Creates a new instance of SequenceFrame.

  Parameters:
    `text` - The text to draw in this frame.
    `absoluteDir` - The new absolute directory.
    `bgImagePath` - The relative path to the background image.
    `bgMusicPath` - The relative path to the background music.

Method Detail

### setText

    public void setText(java.lang.String text)

  Set the text to draw in this frame.

  Parameters:
    `text` - The text to draw in this frame.

### getText

    public java.lang.String getText()

  Returns the text to draw in this frame.

  Returns:
    The text to draw in this frame.

### getBgMusicPath

    public java.lang.String getBgMusicPath()

  Returns the relative path to the background music.

  Returns:
    The relative path to the background music.

### setBgMusicPath

    public void setBgMusicPath(java.lang.String bgMusicPath)

  Sets the relative path to the background music.

  Parameters:
    `bgMusicPath` - The relative path to the background music.

### getBgMusicPathAbsolute

    public java.lang.String getBgMusicPathAbsolute()

  Returns the absolute path to the background music.

  Returns:
    The absolute path to the background music.

### setBgImagePath

    public void setBgImagePath(java.lang.String bgImagePath)

  Sets the relative path to the background image.

  Parameters:
    `bgImagePath` - The relative path to the background image.

### getBgImagePath

    public java.lang.String getBgImagePath()

  Returns the relative path to the background image.

  Returns:
    The relative path to the background image.

### getBgImagePathAbsolute

    public java.lang.String getBgImagePathAbsolute()

  Returns the absolute path to the background image.

  Returns:
    The absolute path to the background image.

### getBgImage

    public java.awt.image.BufferedImage getBgImage()

  Returns the background image for this frame.

  Returns:
    The background image for this frame.

### setAbsoluteDir

    public void setAbsoluteDir(java.lang.String absoluteDir)

  Sets the absolute path to the directory where images and background music are stored.

  Parameters:
    `absoluteDir` - The new absolute directory.

### onDeserialize

    public void onDeserialize(Formatter formatter,
                              java.lang.String absoluteDir)

  The onDeserialize event should be fired after an object is de-serialized. This allows objects to load transient members, set their working directory, and load Storable members if needed.

  Specified by:
    `onDeserialize` in interface `Storable`
  Parameters:
    `formatter` - the formatter to use to load any storable members
    `absoluteDir` - the working directory since all paths stored in the object should be relative

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD