jip
Class JIPSequence

java.lang.Object
  |
  +--jip.JIPSequence

public class JIPSequence
extends java.lang.Object

Descripción:
Clase que define el objeto secuencia. Una secuencia representa una lista ordenada de frames cada uno de los cuales es un objeto imagen. Los tipos de imágenes que corresponden a los frames no tienen por qué coincidir así como tampoco las dimensiones de las imágenes. El número de frames de una secuencia puede variar durante la vida del objeto e incluso puede ser 0 (secuencia vacía). El acceso a las imágenes de una secuencia se realiza con un índice entero en el rango [0..numframes-1]. Podremos añadir, insertar y eliminar frames de una secuencia así como añadir otras secuencias al final. También podremos obtener o reasignar la imagen de un frame de la secuencia. El objeto secuencia es el que siempre se almacena en un fichero con formato JIP (salvo la secuencia vacía que no se almacena). De este modo, para almacenar una única imagen en fichero tendremos que crear una secuencia con un solo frame que la contenga. Los métodos para salvar y cargar secuencias se encuentran en la clase JIPToolkit y no en la propia clase secuencia. El motivo de separarlos es que el formato del fichero no es inherente a la estructura de la secuencia y de esta forma podemos cambiarlo sin tener que tocar esta clase. Por último, a una secuencia podemos darle un nombre que por defecto será "[Unnamed]".

See Also:
JIPToolkit.getSeqFromFile(java.lang.String), JIPToolkit.saveSeqIntoFile(jip.JIPSequence, java.lang.String)

Field Summary
(package private)  java.util.Vector frames
          Vector que contiene los frames de la secuencia
(package private)  java.lang.String name
          Nombre de la secuencia
(package private)  int nframes
          Número de Frames que componen la Secuencia
 
Constructor Summary
JIPSequence()
           Descripción:
Constructor de una secuencia vacía (sin ningún frame).
JIPSequence(JIPImage img)
           Descripción:
Constructor de una secuencia con un solo frame.
JIPSequence(JIPSequence seq)
           Descripción:
Constructor de una secuencia como copia de otra.
 
Method Summary
 void addFrame(JIPImage img)
           Descripción:
Añade un frame al final de la secuencia.
 void appendSequence(JIPSequence seq)
           Descripción:
Añade una secuencia al final de la secuencia.
 JIPImage getFrame(int n)
           Descripción:
Obtiene la imagen correspondiente a un frame de la secuencia.
 java.lang.String getName()
           Descripción:
Obtiene el nombre de la secuencia.
 int getNumFrames()
           Descripción:
Obtiene el número de frames de la secuencia.
 void insertFrame(JIPImage img, int n)
           Descripción:
Inserta un frame en la secuencia.
 void removeAllFrames()
           Descripción:
Elimina todos los frames de la secuencia (quedará vacía).
 void removeFrame(int n)
           Descripción:
Elimina un frame de la secuencia.
 void setFrame(JIPImage img, int n)
           Descripción:
Asigna una imagen a un frame de la secuencia.
 void setName(java.lang.String nom)
           Descripción:
Asigna el nombre de la secuencia.
 java.lang.String toString()
           Descripción:
Funcion de Representación
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

nframes

int nframes
Número de Frames que componen la Secuencia

name

java.lang.String name
Nombre de la secuencia

frames

java.util.Vector frames
Vector que contiene los frames de la secuencia
Constructor Detail

JIPSequence

public JIPSequence()

Descripción:
Constructor de una secuencia vacía (sin ningún frame).


JIPSequence

public JIPSequence(JIPImage img)

Descripción:
Constructor de una secuencia con un solo frame.

Parameters:
img - Imagen correspondiente al frame de la secuencia.

JIPSequence

public JIPSequence(JIPSequence seq)

Descripción:
Constructor de una secuencia como copia de otra.

Parameters:
seq - Secuencia de referencia para construir la copia.
Method Detail

toString

public java.lang.String toString()

Descripción:
Funcion de Representación

Overrides:
toString in class java.lang.Object
Returns:
Cadena de texto con la descripción de la secuencia.

getNumFrames

public int getNumFrames()

Descripción:
Obtiene el número de frames de la secuencia.

Returns:
Número de frames.

getName

public java.lang.String getName()

Descripción:
Obtiene el nombre de la secuencia.

Returns:
Nombre de la secuencia.

setName

public void setName(java.lang.String nom)

Descripción:
Asigna el nombre de la secuencia.

Parameters:
nom - Nombre de la secuencia.

getFrame

public JIPImage getFrame(int n)

Descripción:
Obtiene la imagen correspondiente a un frame de la secuencia.

Parameters:
n - Número de frame (0 <= n <= numframes-1)
Returns:
Imagen correspondiente al frame n. null si n no corresponde a un frame de la secuencia.

setFrame

public void setFrame(JIPImage img,
                     int n)

Descripción:
Asigna una imagen a un frame de la secuencia.

Parameters:
img - Imagen que será asignada al frame.
n - Número de frame al que se asignará la imagen. n indica el índice del frame a asignar, por tanto, debe corresponder a un índice de un frame ya existente siendo: 0 <= n <= numframes-1.

addFrame

public void addFrame(JIPImage img)

Descripción:
Añade un frame al final de la secuencia.

Parameters:
img - Imagen correspondiente al frame añadido.

insertFrame

public void insertFrame(JIPImage img,
                        int n)

Descripción:
Inserta un frame en la secuencia.

Parameters:
img - Imagen correspondiente al frame insertado.
n - Posición correspondiente al frame insertado. n indica el índice del frame a insertar, por tanto, debe corresponder a un índice de un frame ya existente siendo: 0 <= n <= numframes-1. Aquellos frames cuyo índice era igual o mayor que n verán incrementado su índice en una unidad.

removeFrame

public void removeFrame(int n)

Descripción:
Elimina un frame de la secuencia.

Parameters:
n - Numero de frame (0 <= n <= numframes-1)

removeAllFrames

public void removeAllFrames()

Descripción:
Elimina todos los frames de la secuencia (quedará vacía).


appendSequence

public void appendSequence(JIPSequence seq)

Descripción:
Añade una secuencia al final de la secuencia.

Parameters:
seq - Secuencia a añadir.