org.eclipse.pde.internal.swt.tools

Class IconExe

java.lang.Object

org.eclipse.pde.internal.swt.tools.IconExe

public class IconExe
extends java.lang.Object

Customize the icon of a Windows exe WARNING! This class is not part of SWT API. It is NOT API. It is an internal tool that may be changed or removed at anytime. Based on MSDN "An In-Depth Look into the Win32 Portable Executable File Format". Win x64 support (Bug #238001) based on MSDN "x64 Primer: Everything You Need To Know To Start Programming 64-Bit Windows Systems".

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IconExe.BITMAPINFOHEADER
static class	IconExe.CURSORDIR
static class	IconExe.FileFormat
static class	IconExe.ICONRESDIR
static class	IconExe.IconResInfo
static class	IconExe.IMAGE_DATA_DIRECTORY
static class	IconExe.IMAGE_DOS_HEADER
static class	IconExe.IMAGE_FILE_HEADER
static class	IconExe.IMAGE_NT_HEADERS
static class	IconExe.IMAGE_OPTIONAL_HEADER
static class	IconExe.IMAGE_RESOURCE_DATA_ENTRY
static class	IconExe.IMAGE_RESOURCE_DIRECTORY
static class	IconExe.IMAGE_RESOURCE_DIRECTORY_ENTRY
static class	IconExe.IMAGE_SECTION_HEADER
static class	IconExe.NEWHEADER
static class	IconExe.RESDIR

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Constructor Summary

Constructors

Constructor and Description
IconExe()

Method Summary

Modifier and Type	Method and Description
static org.eclipse.pde.internal.swt.tools.IconExe.ImageData[]	loadImages(java.io.File[] icons, java.util.function.Consumer<java.lang.String> errorMessageConsumer) Loads images from files so they are prepared for used in replacing icons in a launcher executable
static void	main(java.lang.String[] args) Replace the Desktop icons provided in the Windows executable program with matching icons provided by the user.
static java.util.Collection<IconExe.IconResInfo>	replaceIcons(java.io.File launcherFile, org.eclipse.pde.internal.swt.tools.IconExe.ImageData[] icons, java.util.function.Consumer<java.lang.String> errorMessageConsumer) Replace the Desktop icons provided in the Windows executable program with icons provided by the user.

Methods inherited from class java.lang.Object

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

Field Detail

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

Constructor Detail

IconExe

public IconExe()

Method Detail

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Replace the Desktop icons provided in the Windows executable program with matching icons provided by the user. Takes 2 arguments argument 0: the Windows executable e.g c:/eclipse/eclipse.exe argument 1: The .ico file to write to the given executable e.g. c:/myApp.ico Note 1. Write access to the executable program is required. As a result, that program must not be currently running or edited elsewhere. Note 2. The Eclipse 3.4 launcher requires an .ico file with the following 7 images (in any order). 1. 48x48, 32 bit (RGB / Alpha Channel) 2. 32x32, 32 bit (RGB / Alpha Channel) 3. 16x16, 32 bit (RGB / Alpha Channel) 4. 48x48, 8 bit (256 colors) 5. 32x32, 8 bit (256 colors) 6. 24x24, 8 bit (256 colors) 7. 16x16, 8 bit (256 colors) Note 3. The Eclipse 4.2 launcher requires an .ico file with the following 7 images (in any order). 1. 256x256, 32 bit (RGB / Alpha Channel) 2. 48x48, 32 bit (RGB / Alpha Channel) 3. 32x32, 32 bit (RGB / Alpha Channel) 4. 16x16, 32 bit (RGB / Alpha Channel) 5. 48x48, 8 bit (256 colors) 6. 32x32, 8 bit (256 colors) 7. 16x16, 8 bit (256 colors) A user icon matching exactly the width/height/depth of an executable icon will be written to the executable and will replace that executable icon. If an executable icon does not match a user icon, it is silently left as is. Note 4. This function modifies the content of the executable program and may cause its corruption.

Throws:

java.lang.Exception

loadImages

public static org.eclipse.pde.internal.swt.tools.IconExe.ImageData[] loadImages(java.io.File[] icons,
                                                                                java.util.function.Consumer<java.lang.String> errorMessageConsumer)
                                                                         throws java.io.IOException

Loads images from files so they are prepared for used in replacing icons in a launcher executable

Parameters:

icons - the icons to loader

errorMessageConsumer - a consumer that is informed about skipable errors while loading icons

Returns:

an array of image data that could be used to replace launcher icons

Throws:

java.io.IOException - if reading of files fails on the I/O level

replaceIcons

public static java.util.Collection<IconExe.IconResInfo> replaceIcons(java.io.File launcherFile,
                                                                     org.eclipse.pde.internal.swt.tools.IconExe.ImageData[] icons,
                                                                     java.util.function.Consumer<java.lang.String> errorMessageConsumer)
                                                              throws java.io.FileNotFoundException,
                                                                     java.io.IOException

Replace the Desktop icons provided in the Windows executable program with icons provided by the user. Note 1. Write access to the executable program is required. As a result, that program must not be currently running or edited elsewhere. Note 2. Use loadIcons to determine which set of icons (width, height, depth) is required to replace the icons in the executable program. A user icon matching exactly the width/height/depth of an executable icon will be written to the executable and will replace that executable icon. If an executable icon does not match a user icon, it is left as is. Verify the return value matches the number of icons to write. Finally, use loadIcons after this operation to verify the icons have changed as expected. Note 3. The Eclipse 3.4 launcher requires the following 7 images (in any order). 1. 48x48, 32 bit (RGB / Alpha Channel) 2. 32x32, 32 bit (RGB / Alpha Channel) 3. 16x16, 32 bit (RGB / Alpha Channel) 4. 48x48, 8 bit (256 colors) 5. 32x32, 8 bit (256 colors) 6. 24x24, 8 bit (256 colors) 7. 16x16, 8 bit (256 colors) Note 4. The Eclipse 4.2 launcher requires the following 7 images (in any order). 1. 256x256, 32 bit (RGB / Alpha Channel) 2. 48x48, 32 bit (RGB / Alpha Channel) 3. 32x32, 32 bit (RGB / Alpha Channel) 4. 16x16, 32 bit (RGB / Alpha Channel) 5. 48x48, 8 bit (256 colors) 6. 32x32, 8 bit (256 colors) 7. 16x16, 8 bit (256 colors) Note 4. This function modifies the content of the executable program and may cause its corruption.

Parameters:

launcherFile - the Windows executable e.g c:/eclipse/eclipse.exe

icons - to write to the given executable

Returns:

the list of icons from the original program that were not successfully replaced (empty if success)

Throws:

java.io.FileNotFoundException

java.io.IOException