org.jfree.pixie.wmf.records
Class MfCmdAnimatePalette

java.lang.Object
  extended byorg.jfree.pixie.wmf.records.MfCmd
      extended byorg.jfree.pixie.wmf.records.MfCmdAnimatePalette

public class MfCmdAnimatePalette
extends MfCmd

The AnimatePalette function replaces entries in the specified logical palette.

 BOOL AnimatePalette(
  HPALETTE hpal,           // handle to logical palette
  UINT iStartIndex,        // first entry in logical palette
  UINT cEntries,           // number of entries
  CONST PALETTEENTRY *ppe  // first replacement
 );
 
This function is not implemented. However, you can use this implementation to create a valid record.


Constructor Summary
MfCmdAnimatePalette()
          DefaultConstructor.
 
Method Summary
 java.awt.Color[] getEntries()
           
 int getEntriesCount()
          Returns the number of colors defined for the AnimatePalette command.
 int getFunction()
          Reads the function identifiert .Every record type is identified by a function number corresponding to one of the Windows GDI functions used.
 int getHPalette()
           
 MfCmd getInstance()
          Creates a empty unintialized copy of this command implementation.
 MfRecord getRecord()
          Creates a new record based on the data stored in the MfCommand.
 void replay(WmfFile file)
          Replays the command on the given WmfFile.
protected  void scaleXChanged()
          Not implemented as no scaling needed for this operation.
protected  void scaleYChanged()
          Not implemented as no scaling needed for this operation.
 void setEntries(java.awt.Color[] colors)
           
 void setHPalette(int hPalette)
           
 void setRecord(MfRecord record)
          Reads the command data from the given record and adjusts the internal parameters according to the data parsed.
 java.lang.String toString()
          Returns a string representation of this command.
 
Methods inherited from class org.jfree.pixie.wmf.records.MfCmd
applyScaleX, applyScaleY, getScaledHeight, getScaledWidth, getScaledX, getScaledY, scaleRect, setScale
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MfCmdAnimatePalette

public MfCmdAnimatePalette()
DefaultConstructor.

Method Detail

getEntriesCount

public int getEntriesCount()
Returns the number of colors defined for the AnimatePalette command.

Returns:
the number of colors or 0 if no colors are defined.

getRecord

public MfRecord getRecord()
                   throws RecordCreationException
Creates a new record based on the data stored in the MfCommand.

Specified by:
getRecord in class MfCmd
Returns:
the created record.
Throws:
RecordCreationException

setRecord

public void setRecord(MfRecord record)
Reads the command data from the given record and adjusts the internal parameters according to the data parsed.

This method is not implemented, as a Palette implementation is still missing.

Specified by:
setRecord in class MfCmd
Parameters:
record - the record.

getFunction

public int getFunction()
Reads the function identifiert .Every record type is identified by a function number corresponding to one of the Windows GDI functions used.

Specified by:
getFunction in class MfCmd
Returns:
MfType.ANIMATE_PALETTE.

replay

public void replay(WmfFile file)
Replays the command on the given WmfFile.

Specified by:
replay in class MfCmd
Parameters:
file - the meta file.

toString

public java.lang.String toString()
Returns a string representation of this command.

Returns:
the command as string.

getInstance

public MfCmd getInstance()
Creates a empty unintialized copy of this command implementation.

Specified by:
getInstance in class MfCmd
Returns:
a new instance of the command.

getHPalette

public int getHPalette()

setHPalette

public void setHPalette(int hPalette)

getEntries

public java.awt.Color[] getEntries()

setEntries

public void setEntries(java.awt.Color[] colors)

scaleXChanged

protected void scaleXChanged()
Not implemented as no scaling needed for this operation.

Specified by:
scaleXChanged in class MfCmd

scaleYChanged

protected void scaleYChanged()
Not implemented as no scaling needed for this operation.

Specified by:
scaleYChanged in class MfCmd