com.softwareag.mobile.reshandler

Class AntTaskResourceHandler

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.softwareag.mobile.reshandler.AntTaskResourceHandler

All Implemented Interfaces:

ParameterTypes, java.lang.Cloneable

public class AntTaskResourceHandler
extends org.apache.tools.ant.Task
implements ParameterTypes

The resource handling in the Mobile Designer's build script.
All the resources will be numbered sequentially in the order you add them
All the lines of text will be numbered sequentially in the order they exist in the added text files

Field Summary

Fields

Modifier and Type	Field and Description
int	check_word_length Override the value in here to set the length that the internal long-word-warnings should kick in at
int	IMAGEDIMENSION_CELL_CROPPED_HEIGHT Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_CELL_CROPPED_TL_X Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_CELL_CROPPED_TL_Y Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_CELL_CROPPED_WIDTH Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_CELL_HEIGHT Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_CELL_WIDTH Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_HEIGHT Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_NUM_CELLS_HIGH Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_NUM_CELLS_WIDE Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEDIMENSION_WIDTH Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image.
int	IMAGEFORMAT_ENCODEDPIXELDATA_NOPALETTE The various image formats that you can select
int	IMAGEFORMAT_ENCODEDPIXELDATA_NOPALETTE_WILLTRANSFORM The various image formats that you can select
int	IMAGEFORMAT_RAWPNG The various image formats that you can select
int	IMAGEFORMAT_RAWPNG_NOPALETTE The various image formats that you can select
int	IMAGEFUNCTION_OKAY_TO_REFORMAT_PALETTE OR this flag with the ImageFormat to allow the code to reformat any in-built palette to solve any handset problems.
static int	MENU_ITEMTYPE_BUTTON The default types of menu item - these can be extended upon as required
static int	MENU_ITEMTYPE_HEADER The default types of menu item - these can be extended upon as required
static int	MENU_ITEMTYPE_SOFTKEY The default types of menu item - these can be extended upon as required
static int	MENU_ITEMTYPE_TEXT The default types of menu item - these can be extended upon as required
int	NATIVEFORMAT_ABGR_1555 The various native image formats that you can select
int	NATIVEFORMAT_ABGR_1555_CCW90 The various native image formats that you can select
int	NATIVEFORMAT_PNG_WITH_SEPARATED_ALPHA The various native image formats that you can select
static java.lang.String	resourcePrefix
boolean	save_languages Override the value in here to prevent the languages from being saved out (useful if you're not really using the Mobile Designer's text functionality)
boolean	save_resmap Override the value in here to prevent the resmap being saved out (useful if you're not really using the Mobile Designer's resource functionality)

Fields inherited from interface com.softwareag.mobile.core.ParameterTypes

Param_Bool, Param_Byte, Param_Char, Param_Double, Param_Float, Param_Int, Param_Long, param_mappings, Param_MenuID, Param_ResBlockID, Param_ResID, Param_Short, Param_String, Param_TextID, ParamMap_ConstantHeader, ParamMap_JavaIdentifier, ParamMap_ParamName, ParamMap_ValueWrapper, ParamMaps

Constructor Summary

Constructors

Constructor and Description
AntTaskResourceHandler()

Method Summary

Methods

Modifier and Type	Method and Description
void	addArray(java.lang.String resname, byte[] resarray) Creates a resource from a byte array and adds it to the current resource block
void	addArray(java.lang.String resname, byte[] resarray, int offset, int length) Creates a resource from a byte array and adds it to the current resource block
void	addArray(java.lang.String resname, char[] resarray) Creates a resource from a char array and adds it to the current resource block
void	addArray(java.lang.String resname, char[] resarray, int offset, int length) Creates a resource from a char array and adds it to the current resource block
void	addArray(java.lang.String resname, double[] resarray) Creates a resource from a double array and adds it to the current resource block
void	addArray(java.lang.String resname, double[] resarray, int offset, int length) Creates a resource from a double array and adds it to the current resource block
void	addArray(java.lang.String resname, float[] resarray) Creates a resource from a float array and adds it to the current resource block
void	addArray(java.lang.String resname, float[] resarray, int offset, int length) Creates a resource from a float array and adds it to the current resource block
void	addArray(java.lang.String resname, int[] resarray) Creates a resource from an int array and adds it to the current resource block
void	addArray(java.lang.String resname, int[] resarray, int offset, int length) Creates a resource from an int array and adds it to the current resource block
void	addArray(java.lang.String resname, long[] resarray) Creates a resource from a long array and adds it to the current resource block
void	addArray(java.lang.String resname, long[] resarray, int offset, int length) Creates a resource from a long array and adds it to the current resource block
void	addArray(java.lang.String resname, short[] resarray) Creates a resource from a short array and adds it to the current resource block
void	addArray(java.lang.String resname, short[] resarray, int offset, int length) Creates a resource from a short array and adds it to the current resource block
void	addFile(java.lang.String resname, java.lang.String resfile) Creates a resource from a file and adds it to the current resource block
void	addFont(java.lang.String resname, java.lang.String resfile, java.lang.String chars, int width_cells, int height_cells, int space_width, int character_spacing) Adds a bitmap font, which can be used proportionally or fixed-width in the run-time code for drawing Strings or char-arrays.
void	addFont(java.lang.String resname, java.lang.String resfile, java.lang.String chars, int width_cells, int height_cells, int space_width, int character_spacing, int export_format) Adds a bitmap font, which can be used proportionally or fixed-width in the run-time code for drawing Strings or char-arrays.
void	addImage(java.lang.String resname, byte[] resarray, int offset, int length, java.lang.String refpalette, int export_format, int width_cells, int height_cells) Creates an image from an array and adds it to the current resource block.
void	addImage(java.lang.String resname, byte[] resarray, java.lang.String refpalette, int export_format, int width_cells, int height_cells) Creates an image from an array and adds it to the current resource block.
void	addImage(java.lang.String resname, java.lang.String resfile) Creates an image from an image-file and adds it to the current resource block (can be flipped at runtime).
void	addImage(java.lang.String resname, java.lang.String resfile, java.lang.String refpalette, int export_format, int width_cells, int height_cells) Creates an image from an image-file and adds it to the current resource block.
void	addMenu(java.lang.String menuname, int type, int[]... items) Adds this menu definition to the menu pool.
void	addMidletIconToJar(java.lang.String file) Adds the midlet icon to the jar.
void	addMidletIconToJar(java.lang.String file, boolean overwrite)
void	addPalette(java.lang.String resname, int[] argb_palette) Adds an ARGB palette with the specified name to the current resource block
void	addPalette(java.lang.String resname, java.lang.String resfile, boolean first_colour_transparent) Adds a palette based on a PSP .pal file
void	addRawImage(java.lang.String resname, java.lang.String resfile) Creates an image from an image-file and adds it to the current resource block (can't be flipped at runtime).
void	addSound(java.lang.String resname, java.lang.String resfile) Creates a resource from a sound-file and adds it to the current resource block
void	addUnpackedDirToJar(java.lang.String target_prefix, boolean recurse_subfolders) Adds all the files in the current directory as unpacked files
void	addUnpackedFileToJar(java.lang.String file, java.lang.String target_filename) Adds a file that won't get included in the resource packing at all
void	addUnpackedFileToJar(java.lang.String file, java.lang.String target_filename, boolean overwrite)
void	addUnpackedFileToJarFromArray(byte[] source_array, java.lang.String target_filename) Adds an array as a file that won't get included in the resource packing at all
void	allocateResourceBlockToPack(java.lang.String resblock, int packid) Decides which of the packed resource file each resource block will be put in.
byte[]	encodeFullColourImage(int width, int height, int[] pixel_argbs) Encodes a non-palettised image into a proprietary format.
byte[]	encodeImage(int width, int height, int[] pixel_argbs, int[] palette) Encodes an image into a proprietary format.
byte[]	encodeNative(byte[] png_data, int encoding_format) Encodes a PNG into a native format (Made public so you can override with your own encodings)
byte[]	encodeNativeFromFile(java.lang.String file_name, int encoding_format) Encodes a PNG into a native format from a supplied file (Made public so you can override with your own encodings)
void	exceptionError(java.lang.Exception e, java.lang.String string) Outputs an Error message to the console, based on an Exception
void	execute() Launch method
boolean	getBoolParam(java.lang.String param) Retrieves a boolean parameter (or false if the parameter can't be found)
double	getDoubleParam(java.lang.String param) Retrieves a double parameter (or 0.0 if the parameter can't be found)
float	getFloatParam(java.lang.String param) Retrieves a float parameter (or 0.0 if the parameter can't be found)
int	getImageDimension(java.lang.String resname, int cell, int dimension) Returns the appropriate dimension for a particular cached image / cell
int	getImageHeight(java.lang.String resname) Returns the height of a loaded image (or 0 if this image doesn't exist)
boolean	getImageTransparency(java.lang.String resname) Returns whether an image contains transparency (or false if this image doesn't exist)
int	getImageWidth(java.lang.String resname) Returns the width of a loaded image (or 0 if this image doesn't exist)
int	getIntParam(java.lang.String param) Retrieves an integer parameter (or 0 if the parameter can't be found)
java.lang.String	getLanguage(int lang_id) Returns the 2-character identifier for this specific language in this build
long	getLongParam(java.lang.String param) Retrieves a long parameter (or 0 if the parameter can't be found)
int	getMenuID(java.lang.String menuname) Returns the ID of a menu (might not be created yet)
int	getNumLanguages() Returns the number of languages in this build
int	getNumTextStrings() Returns the number of strings defined
java.lang.String	getPath(java.lang.String pathname) Retrieves a path as a ;-delimited String (or "" if the path can't be found)
java.lang.String	getProperty(java.lang.String property) Retrieves a property from ant - will return "" if it doesn't exist, but will throw a warning
int	getResID(java.lang.String resname) Returns the resourceID for a given resource (or -1 if it cannot be found)
java.lang.String	getResourceReadDirectory() Gets the resource directory that all future files will be read from
java.lang.String	getStringParam(java.lang.String param) Retrieves a String parameter (or "" if the parameter can't be found)
int	getTextID(java.lang.String identifier) Returns the textID for a given string identifier (or -1 if it cannot be found)
java.lang.String	getTextString(int text_id, int language) Returns the language string for a particular textid
void	includeTextFile(java.lang.String textfile) Equivalent to "includeTextFile (textfile, true)"
void	includeTextFile(java.lang.String textfile, boolean remember_text) Points to an ANSI or Unicode textfile to be included - will append ".{lang}.txt" to the filename for each required language.
int[]	menuItemButton(int text_id, int flags, int action) Creates a button item for the menus
int[]	menuItemButton(java.lang.String textname, int flags, int action) (A version of menuItemButton where you can just pass in the textname as a String)
int[]	menuItemHeader(int text_id) Create a header item for the menus
int[]	menuItemHeader(java.lang.String textname) (A version of menuItemHeader where you can just pass in the textname as a String)
int[]	menuItemSoftkey(int text_id, boolean fwrd, int action) Creates a softkey item for the menus
int[]	menuItemSoftkey(java.lang.String textname, boolean fwrd, int action) (A version of menuItemSoftkey where you can just pass in the textname as a String)
int[]	menuItemText(int text_id) Creates a text item for the menus
int[]	menuItemText(java.lang.String textname) (A version of menuItemText where you can just pass in the textname as a String)
void	okayToSkip(boolean okay_to_skip) Sets whether it's okay to skip future missing resource-files if you don't call a method that states it specifically
int	readBMPIntFromByteArray(byte[] arrayB, int index) Helper method for createWinCEMidletIcon
java.io.ByteArrayOutputStream	scaleImage(java.io.InputStream bis, int twidth, int theight, boolean distort, java.lang.String output_format)
void	setMenuID(java.lang.String idname, int value) Similar to setParam(int), but sets a MENUID_ value.
void	setParam(java.lang.String param, boolean value) Sets in Parameters.java: public static final bool PARAM_{param} = {value};
void	setParam(java.lang.String param, double value) Sets in Parameters.java: public static final double PARAM_{param} = {value};
void	setParam(java.lang.String param, float value) Sets in Parameters.java: public static final float PARAM_{param} = {value};
void	setParam(java.lang.String param, int value) Sets in Parameters.java: public static final int PARAM_{param} = {value};
void	setParam(java.lang.String param, long value) Sets in Parameters.java: public static final long PARAM_{param} = {value};
void	setParam(java.lang.String param, java.lang.String value) Sets in Parameters.java: public static final String PARAM_{param} = "{value}";
void	setProperty(java.lang.String property, java.lang.String value) Sets an ant property (note - doesn't adhere to the immutability of properties)
void	setResBlockID(java.lang.String idname, int value) Similar to setParam(int), but sets a RESBLOCKID_ value.
void	setResID(java.lang.String idname, int value) Similar to setParam(int), but sets a RESID_ value.
void	setResIDVisibility(java.lang.String idname, boolean visibility) Specifies the visibility of ResIDs.
void	setResourceReadDirectory(java.lang.String resdir) Sets the absolute resource directory that all future files will be read from.
void	setResourceReadSubdirectory(java.lang.String ressubdir) Sets the resource directory (relative to the ${project.resource.dir.root}) that all future files will be read from.
void	setTextID(java.lang.String idname, int value) Similar to setParam(int), but sets a TEXTID_ value.
void	silenceWarnings(boolean silence_warnings) Sets whether future warnings should be silenced from the console
void	startResourceBlock(java.lang.String resblock) Sets which resource block future 'adds' will be added to.
void	warningOrError(java.lang.String string, boolean error) Outputs a warning or Error message to the console - Errors will cause an org.apache.tools.ant.BuildException
int	writeBMPIntIntoByteArray(byte[] arrayB, int index, int value) Helper method for createBREWMidletIcon

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, init, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MENU_ITEMTYPE_SOFTKEY

public static final int MENU_ITEMTYPE_SOFTKEY

The default types of menu item - these can be extended upon as required

See Also:

Constant Field Values

MENU_ITEMTYPE_HEADER

public static final int MENU_ITEMTYPE_HEADER

The default types of menu item - these can be extended upon as required

See Also:

Constant Field Values

MENU_ITEMTYPE_TEXT

public static final int MENU_ITEMTYPE_TEXT

The default types of menu item - these can be extended upon as required

See Also:

Constant Field Values

MENU_ITEMTYPE_BUTTON

public static final int MENU_ITEMTYPE_BUTTON

The default types of menu item - these can be extended upon as required

See Also:

Constant Field Values

IMAGEDIMENSION_WIDTH

public final int IMAGEDIMENSION_WIDTH

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_HEIGHT

public final int IMAGEDIMENSION_HEIGHT

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_NUM_CELLS_WIDE

public final int IMAGEDIMENSION_NUM_CELLS_WIDE

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_NUM_CELLS_HIGH

public final int IMAGEDIMENSION_NUM_CELLS_HIGH

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_CELL_WIDTH

public final int IMAGEDIMENSION_CELL_WIDTH

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_CELL_HEIGHT

public final int IMAGEDIMENSION_CELL_HEIGHT

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_CELL_CROPPED_WIDTH

public final int IMAGEDIMENSION_CELL_CROPPED_WIDTH

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_CELL_CROPPED_HEIGHT

public final int IMAGEDIMENSION_CELL_CROPPED_HEIGHT

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_CELL_CROPPED_TL_X

public final int IMAGEDIMENSION_CELL_CROPPED_TL_X

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEDIMENSION_CELL_CROPPED_TL_Y

public final int IMAGEDIMENSION_CELL_CROPPED_TL_Y

Specifies the various dimensional, cell, and cell-cropping info that can be queried about a particular image. The Top-Left X and Y are relative to the origin of the master image

See Also:

Constant Field Values

IMAGEFORMAT_RAWPNG

public final int IMAGEFORMAT_RAWPNG

The various image formats that you can select

See Also:

Constant Field Values

IMAGEFORMAT_RAWPNG_NOPALETTE

public final int IMAGEFORMAT_RAWPNG_NOPALETTE

The various image formats that you can select

See Also:

Constant Field Values

IMAGEFORMAT_ENCODEDPIXELDATA_NOPALETTE

public final int IMAGEFORMAT_ENCODEDPIXELDATA_NOPALETTE

The various image formats that you can select

See Also:

Constant Field Values

IMAGEFORMAT_ENCODEDPIXELDATA_NOPALETTE_WILLTRANSFORM

public final int IMAGEFORMAT_ENCODEDPIXELDATA_NOPALETTE_WILLTRANSFORM

The various image formats that you can select

See Also:

Constant Field Values

IMAGEFUNCTION_OKAY_TO_REFORMAT_PALETTE

public final int IMAGEFUNCTION_OKAY_TO_REFORMAT_PALETTE

OR this flag with the ImageFormat to allow the code to reformat any in-built palette to solve any handset problems.
This will get around issues where transparent keycolours need to be index 0, but haven't been created so in the source images.
This flag should only be applied to the ENCODEDPIXELDATA format

See Also:

Constant Field Values

NATIVEFORMAT_ABGR_1555

public final int NATIVEFORMAT_ABGR_1555

The various native image formats that you can select

See Also:

Constant Field Values

NATIVEFORMAT_ABGR_1555_CCW90

public final int NATIVEFORMAT_ABGR_1555_CCW90

The various native image formats that you can select

See Also:

Constant Field Values

NATIVEFORMAT_PNG_WITH_SEPARATED_ALPHA

public final int NATIVEFORMAT_PNG_WITH_SEPARATED_ALPHA

The various native image formats that you can select

See Also:

Constant Field Values

check_word_length

public int check_word_length

Override the value in here to set the length that the internal long-word-warnings should kick in at

save_resmap

public boolean save_resmap

Override the value in here to prevent the resmap being saved out (useful if you're not really using the Mobile Designer's resource functionality)

save_languages

public boolean save_languages

Override the value in here to prevent the languages from being saved out (useful if you're not really using the Mobile Designer's text functionality)

resourcePrefix

public static final java.lang.String resourcePrefix

See Also:

Constant Field Values

Constructor Detail

AntTaskResourceHandler

public AntTaskResourceHandler()

Method Detail

warningOrError

public void warningOrError(java.lang.String string,
                  boolean error)

Outputs a warning or Error message to the console - Errors will cause an org.apache.tools.ant.BuildException

silenceWarnings

public void silenceWarnings(boolean silence_warnings)

Sets whether future warnings should be silenced from the console

exceptionError

public void exceptionError(java.lang.Exception e,
                  java.lang.String string)

Outputs an Error message to the console, based on an Exception

getProperty

public java.lang.String getProperty(java.lang.String property)

Retrieves a property from ant - will return "" if it doesn't exist, but will throw a warning

setProperty

public void setProperty(java.lang.String property,
               java.lang.String value)

Sets an ant property (note - doesn't adhere to the immutability of properties)

getPath

public java.lang.String getPath(java.lang.String pathname)

Retrieves a path as a ;-delimited String (or "" if the path can't be found)

getBoolParam

public boolean getBoolParam(java.lang.String param)

Retrieves a boolean parameter (or false if the parameter can't be found)

getIntParam

public int getIntParam(java.lang.String param)

Retrieves an integer parameter (or 0 if the parameter can't be found)

getFloatParam

public float getFloatParam(java.lang.String param)

Retrieves a float parameter (or 0.0 if the parameter can't be found)

getLongParam

public long getLongParam(java.lang.String param)

Retrieves a long parameter (or 0 if the parameter can't be found)

getDoubleParam

public double getDoubleParam(java.lang.String param)

Retrieves a double parameter (or 0.0 if the parameter can't be found)

getStringParam

public java.lang.String getStringParam(java.lang.String param)

Retrieves a String parameter (or "" if the parameter can't be found)

setParam

public void setParam(java.lang.String param,
            boolean value)

Sets in Parameters.java: public static final bool PARAM_{param} = {value};

setParam

public void setParam(java.lang.String param,
            int value)

Sets in Parameters.java: public static final int PARAM_{param} = {value};

setParam

public void setParam(java.lang.String param,
            float value)

Sets in Parameters.java: public static final float PARAM_{param} = {value};

setParam

public void setParam(java.lang.String param,
            long value)

Sets in Parameters.java: public static final long PARAM_{param} = {value};

setParam

public void setParam(java.lang.String param,
            double value)

Sets in Parameters.java: public static final double PARAM_{param} = {value};

setParam

public void setParam(java.lang.String param,
            java.lang.String value)

Sets in Parameters.java: public static final String PARAM_{param} = "{value}";

getResID

public int getResID(java.lang.String resname)

Returns the resourceID for a given resource (or -1 if it cannot be found)

getTextID

public int getTextID(java.lang.String identifier)

Returns the textID for a given string identifier (or -1 if it cannot be found)

getMenuID

public int getMenuID(java.lang.String menuname)

Returns the ID of a menu (might not be created yet)

setResID

public void setResID(java.lang.String idname,
            int value)

Similar to setParam(int), but sets a RESID_ value.
Useful if you want to set a RESID_ so the code will compile even though the resource is not in this build

setResBlockID

public void setResBlockID(java.lang.String idname,
                 int value)

Similar to setParam(int), but sets a RESBLOCKID_ value.
Useful if you want to set a RESBLOCKID_ so the code will compile even though the resource-block is not in this build

setTextID

public void setTextID(java.lang.String idname,
             int value)

Similar to setParam(int), but sets a TEXTID_ value.
Useful if you want to set a TEXTID_ so the code will compile even though the textline is not in this build

setMenuID

public void setMenuID(java.lang.String idname,
             int value)

Similar to setParam(int), but sets a MENUID_ value.
Useful if you want to set a MENUID_ so the code will compile even though the menu is not in this build

setResIDVisibility

public void setResIDVisibility(java.lang.String idname,
                      boolean visibility)

Specifies the visibility of ResIDs. Useful if you do not need all your ResIDs included in the Parameters file, such as when using sequentials.

getNumTextStrings

public int getNumTextStrings()

Returns the number of strings defined

getTextString

public java.lang.String getTextString(int text_id,
                             int language)

Returns the language string for a particular textid

includeTextFile

public void includeTextFile(java.lang.String textfile,
                   boolean remember_text)

Points to an ANSI or Unicode textfile to be included - will append ".{lang}.txt" to the filename for each required language.
".all.txt" can be used as a fallback if you have text you want included for all languages
"@VERSION@" will be replaced by the version number
"@YEAR@" will be replaced by the current year
"@TIMESTAMP@" will be replaced by the current date and time
"\-" will be used as hyphenation guideline info
"\n" will be used as a carriage return
"¬" (or character 0xa0) will be used as a hard, non-breaking space
If remember_text is set to false all the text will come through as blank but all text_id's will be remembered

includeTextFile

public void includeTextFile(java.lang.String textfile)

Equivalent to "includeTextFile (textfile, true)"

getNumLanguages

public int getNumLanguages()

Returns the number of languages in this build

getLanguage

public java.lang.String getLanguage(int lang_id)

Returns the 2-character identifier for this specific language in this build

startResourceBlock

public void startResourceBlock(java.lang.String resblock)

Sets which resource block future 'adds' will be added to.
If this is set to null then this resource will not be packed at compilation time

setResourceReadSubdirectory

public void setResourceReadSubdirectory(java.lang.String ressubdir)

Sets the resource directory (relative to the ${project.resource.dir.root}) that all future files will be read from.
Either null or "" can be used to reference the resource directory's root

setResourceReadDirectory

public void setResourceReadDirectory(java.lang.String resdir)

Sets the absolute resource directory that all future files will be read from.
Either null or "" can be used to reference the resource directory's root

getResourceReadDirectory

public java.lang.String getResourceReadDirectory()

Gets the resource directory that all future files will be read from

addArray

public void addArray(java.lang.String resname,
            byte[] resarray,
            int offset,
            int length)

Creates a resource from a byte array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            byte[] resarray)

Creates a resource from a byte array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addArray

public void addArray(java.lang.String resname,
            char[] resarray,
            int offset,
            int length)

Creates a resource from a char array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            char[] resarray)

Creates a resource from a char array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addArray

public void addArray(java.lang.String resname,
            short[] resarray,
            int offset,
            int length)

Creates a resource from a short array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            short[] resarray)

Creates a resource from a short array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addArray

public void addArray(java.lang.String resname,
            int[] resarray,
            int offset,
            int length)

Creates a resource from an int array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            int[] resarray)

Creates a resource from an int array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addArray

public void addArray(java.lang.String resname,
            long[] resarray,
            int offset,
            int length)

Creates a resource from a long array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            long[] resarray)

Creates a resource from a long array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addArray

public void addArray(java.lang.String resname,
            float[] resarray,
            int offset,
            int length)

Creates a resource from a float array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            float[] resarray)

Creates a resource from a float array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addArray

public void addArray(java.lang.String resname,
            double[] resarray,
            int offset,
            int length)

Creates a resource from a double array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

addArray

public void addArray(java.lang.String resname,
            double[] resarray)

Creates a resource from a double array and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

addFile

public void addFile(java.lang.String resname,
           java.lang.String resfile)

Creates a resource from a file and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resfile - File to read resource from

addSound

public void addSound(java.lang.String resname,
            java.lang.String resfile)

Creates a resource from a sound-file and adds it to the current resource block

Parameters:

resname - Name of resource to use in PARAM_ naming

resfile - File to read resource from

encodeImage

public byte[] encodeImage(int width,
                 int height,
                 int[] pixel_argbs,
                 int[] palette)

Encodes an image into a proprietary format.
The mirror of this is the decodeImage method in the runtime code
(Made public so you can override with your own encodings)

encodeFullColourImage

public byte[] encodeFullColourImage(int width,
                           int height,
                           int[] pixel_argbs)

Encodes a non-palettised image into a proprietary format.
The mirror of this is the decodeImage method in the runtime code
(Made public so you can override with your own encodings)

encodeNative

public byte[] encodeNative(byte[] png_data,
                  int encoding_format)

Encodes a PNG into a native format
(Made public so you can override with your own encodings)

encodeNativeFromFile

public byte[] encodeNativeFromFile(java.lang.String file_name,
                          int encoding_format)

Encodes a PNG into a native format from a supplied file
(Made public so you can override with your own encodings)

addImage

public void addImage(java.lang.String resname,
            java.lang.String resfile,
            java.lang.String refpalette,
            int export_format,
            int width_cells,
            int height_cells)

Creates an image from an image-file and adds it to the current resource block.
If IMAGEFORMAT_RAWPNG is not used as the format, and no reference palette given, a separate resource (named resname+"_PALETTE", id=thisid+1) will be saved that contains the palette

Parameters:

resname - Name of resource to use in PARAM_ naming

resfile - File to read resource from

refpalette - Name of a reference palette that the export data should conform to (or null if none) (can only be used with IMAGEFORMAT_FLIPPABLEPIXELDATA_NOPALETTE format)

export_format - One of the IMAGEFORMATs

width_cells - Number of equidistant sub-cells across the horizontal width of the image

height_cells - Number of equidistant sub-cells across the vertical height of the image

addImage

public void addImage(java.lang.String resname,
            java.lang.String resfile)

Creates an image from an image-file and adds it to the current resource block (can be flipped at runtime).
It's assumed the image is a 1x1 image cell and is not referencing another palette
See the parent addImage method javadoc for a list of the parameters

addRawImage

public void addRawImage(java.lang.String resname,
               java.lang.String resfile)

Creates an image from an image-file and adds it to the current resource block (can't be flipped at runtime).
It's assumed the image is a 1x1 image cell and is not referencing another palette
See the parent addImage method javadoc for a list of the parameters

addImage

public void addImage(java.lang.String resname,
            byte[] resarray,
            int offset,
            int length,
            java.lang.String refpalette,
            int export_format,
            int width_cells,
            int height_cells)

Creates an image from an array and adds it to the current resource block.
If IMAGEFORMAT_RAWPNG is not used as the format, and no reference palette given, a separate resource (named resname+"_PALETTE", id=thisid+1) will be saved that contains the palette

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

offset - Starting index of the array to write

length - Length of array to write

refpalette - Name of a reference palette that the export data should conform to (or null if none) (can only be used with IMAGEFORMAT_FLIPPABLEPIXELDATA_NOPALETTE format)

export_format - One of the IMAGEFORMATs

width_cells - Number of equidistant sub-cells across the horizontal width of the image

height_cells - Number of equidistant sub-cells across the vertical height of the image

addImage

public void addImage(java.lang.String resname,
            byte[] resarray,
            java.lang.String refpalette,
            int export_format,
            int width_cells,
            int height_cells)

Creates an image from an array and adds it to the current resource block.
If IMAGEFORMAT_RAWPNG is not used as the format, and no reference palette given, a separate resource (named resname+"_PALETTE", id=thisid+1) will be saved that contains the palette

Parameters:

resname - Name of resource to use in PARAM_ naming

resarray - Array

refpalette - Name of a reference palette that the export data should conform to (or null if none) (can only be used with IMAGEFORMAT_FLIPPABLEPIXELDATA_NOPALETTE format)

export_format - One of the IMAGEFORMATs

width_cells - Number of equidistant sub-cells across the horizontal width of the image

height_cells - Number of equidistant sub-cells across the vertical height of the image

getImageDimension

public int getImageDimension(java.lang.String resname,
                    int cell,
                    int dimension)

Returns the appropriate dimension for a particular cached image / cell

Parameters:

resname - Name of image resource

cell - The id of the subcell in the image

dimension - The IMAGEDIMENSION_ we're querying

getImageWidth

public int getImageWidth(java.lang.String resname)

Returns the width of a loaded image (or 0 if this image doesn't exist)

getImageHeight

public int getImageHeight(java.lang.String resname)

Returns the height of a loaded image (or 0 if this image doesn't exist)

getImageTransparency

public boolean getImageTransparency(java.lang.String resname)

Returns whether an image contains transparency (or false if this image doesn't exist)

addPalette

public void addPalette(java.lang.String resname,
              int[] argb_palette)

Adds an ARGB palette with the specified name to the current resource block

addPalette

public void addPalette(java.lang.String resname,
              java.lang.String resfile,
              boolean first_colour_transparent)

Adds a palette based on a PSP .pal file

addFont

public void addFont(java.lang.String resname,
           java.lang.String resfile,
           java.lang.String chars,
           int width_cells,
           int height_cells,
           int space_width,
           int character_spacing,
           int export_format)

Adds a bitmap font, which can be used proportionally or fixed-width in the run-time code for drawing Strings or char-arrays. Saves out an image and its font as the following 1 or 2 resources

Parameters:

resname - Name of resource to use in PARAM_ naming

resfile - File to read resource from

chars - A sequential list of the character represented in this font

width_cells - Number of equidistant sub-cells across the horizontal width of the image

height_cells - Number of equidistant sub-cells across the vertical height of the image

space_width - The pixel-width of the space character

character_spacing - The horizontal pixel-spacing between characters

export_format - The format the font's image should be stored in

addFont

public void addFont(java.lang.String resname,
           java.lang.String resfile,
           java.lang.String chars,
           int width_cells,
           int height_cells,
           int space_width,
           int character_spacing)

Adds a bitmap font, which can be used proportionally or fixed-width in the run-time code for drawing Strings or char-arrays.
It's assumed the image could be repalettised at runtime
See the parent addImage method javadoc for a list of the parameters

okayToSkip

public void okayToSkip(boolean okay_to_skip)

Sets whether it's okay to skip future missing resource-files if you don't call a method that states it specifically

menuItemHeader

public int[] menuItemHeader(int text_id)

Create a header item for the menus

menuItemHeader

public int[] menuItemHeader(java.lang.String textname)

(A version of menuItemHeader where you can just pass in the textname as a String)

menuItemText

public int[] menuItemText(int text_id)

Creates a text item for the menus

Parameters:

text_id - TextID

menuItemText

public int[] menuItemText(java.lang.String textname)

(A version of menuItemText where you can just pass in the textname as a String)

menuItemButton

public int[] menuItemButton(int text_id,
                   int flags,
                   int action)

Creates a button item for the menus

Parameters:

text_id - TextID

flags - Any flags (e.g. visibility) (must fit in the 0x00ffff00 mask)

action - ID of what should happen when this item is selected

menuItemButton

public int[] menuItemButton(java.lang.String textname,
                   int flags,
                   int action)

(A version of menuItemButton where you can just pass in the textname as a String)

menuItemSoftkey

public int[] menuItemSoftkey(int text_id,
                    boolean fwrd,
                    int action)

Creates a softkey item for the menus

Parameters:

text_id - TextID

fwrd - Is this the forward softkey?

action - ID of what should happen when this item is selected

menuItemSoftkey

public int[] menuItemSoftkey(java.lang.String textname,
                    boolean fwrd,
                    int action)

(A version of menuItemSoftkey where you can just pass in the textname as a String)

addMenu

public void addMenu(java.lang.String menuname,
           int type,
           int[]... items)

Adds this menu definition to the menu pool.
Can take any arbitrary int-array as an item, as long as the first array-entry defines its type/flags as defined by the appropriate bitmasks

allocateResourceBlockToPack

public void allocateResourceBlockToPack(java.lang.String resblock,
                               int packid)

Decides which of the packed resource file each resource block will be put in.
Any resource in an unnamed or unallocated block will end up included individually

addUnpackedFileToJar

public void addUnpackedFileToJar(java.lang.String file,
                        java.lang.String target_filename)

Adds a file that won't get included in the resource packing at all

addUnpackedFileToJar

public void addUnpackedFileToJar(java.lang.String file,
                        java.lang.String target_filename,
                        boolean overwrite)

addUnpackedDirToJar

public void addUnpackedDirToJar(java.lang.String target_prefix,
                       boolean recurse_subfolders)

Adds all the files in the current directory as unpacked files

Parameters:

target_prefix - Any file/directory prefix that should be added to the target filenames (or NULL for none)

recurse_subfolders - Whether to recurse into all subfolders

addUnpackedFileToJarFromArray

public void addUnpackedFileToJarFromArray(byte[] source_array,
                                 java.lang.String target_filename)

Adds an array as a file that won't get included in the resource packing at all

addMidletIconToJar

public void addMidletIconToJar(java.lang.String file)

Adds the midlet icon to the jar. Calls addUnpackedFileToJar with some preset parameters

addMidletIconToJar

public void addMidletIconToJar(java.lang.String file,
                      boolean overwrite)

writeBMPIntIntoByteArray

public int writeBMPIntIntoByteArray(byte[] arrayB,
                           int index,
                           int value)

Helper method for createBREWMidletIcon

Returns:

New index

readBMPIntFromByteArray

public int readBMPIntFromByteArray(byte[] arrayB,
                          int index)

Helper method for createWinCEMidletIcon

Returns:

Existing value

scaleImage

public java.io.ByteArrayOutputStream scaleImage(java.io.InputStream bis,
                                       int twidth,
                                       int theight,
                                       boolean distort,
                                       java.lang.String output_format)

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Launch method

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException