#11 DEX format - add icons

Author: amosshi

BinaryInternalsViewer/src/main/java/org/freeinternals/biv/JSplitPaneFile.java

@@ -79,6 +79,7 @@ private void createAndShowGUI() {
                 0,
                 this.file.fileByteArray.length,
                 this.file.fileName,
+                this.file.getIcon(),
                 this.file.filePath));
         this.file.generateTreeNode(root);
         final JTree tree = new JTree(new DefaultTreeModel(root));

CommonLib/src/main/java/org/freeinternals/commonlib/core/BytesTool.java

@@ -176,7 +176,7 @@ public static byte[] readFileAsBytes(final File file) {
      * @param zipFile The {@code jar} or {@code zip} file
      * @param zipEntry The entry to be read
      * @return Byte array of the class file, or {@code null} if error happened.
-     * @throws java.io.IOException Error happened when reading the zip file
+     * @throws IOException Error happened when reading the zip file
      */
     public static byte[] readZipEntryAsBytes(final ZipFile zipFile, final ZipEntry zipEntry) throws IOException {
         if (zipFile == null) {

CommonLib/src/main/java/org/freeinternals/commonlib/core/DataInputEx.java

@@ -88,31 +88,31 @@ public interface DataInputEx {
      * <code>long</code> value.
      *
      * @return the <code>long</code> value read.
-     * @throws java.io.IOException I/O Error
+     * @throws IOException I/O Error
      */
     long readUnsignedIntInLittleEndian() throws IOException;
 
     /**
      * Reads eight input bytes and returns a {@code long} value.
      *
      * @return the <code>long</code> value read.
-     * @throws java.io.IOException I/O Error
+     * @throws IOException I/O Error
      */
     long readLongInLittleEndian() throws IOException;
 
     /**
      * Reads eight input bytes and returns a {@code unsigned long} value.
      *
      * @return the <code>unsigned long</code> value read
-     * @throws java.io.IOException I/O Error
+     * @throws IOException I/O Error
      */
     BigInteger readUnsignedLong() throws IOException;
 
     /**
      * Reads eight input bytes and returns a {@code unsigned long} value.
      *
      * @return the <code>unsigned long</code> value read
-     * @throws java.io.IOException I/O Error
+     * @throws IOException I/O Error
      */
     BigInteger readUnsignedLongInLittleEndian() throws IOException;
 
@@ -147,14 +147,14 @@ public interface DataInputEx {
      * Read until a null terminator, or the end of the buffer as binary.
      *
      * @return
-     * @throws java.io.IOException I/O Error
+     * @throws IOException I/O Error
      */
     byte[] readBinary() throws IOException;
 
     /**
      * Skip to the end of the buffer.
      *
-     * @throws java.io.IOException I/O Error
+     * @throws IOException I/O Error
      */
     void skipToEnd() throws IOException;
 

CommonLib/src/main/java/org/freeinternals/commonlib/core/FileFormat.java

@@ -13,6 +13,7 @@
 import java.util.Collections;
 import java.util.SortedMap;
 import java.util.TreeMap;
+import javax.swing.Icon;
 import javax.swing.JScrollPane;
 import javax.swing.JTabbedPane;
 import javax.swing.JTextPane;
@@ -47,8 +48,8 @@ public abstract class FileFormat {
      * Parse the content from a {@link File} object.
      *
      * @param file {@link File} object
-     * @throws java.io.IOException Failed to Read file
-     * @throws org.freeinternals.commonlib.core.FileFormatException The file is empty
+     * @throws IOException Failed to Read file
+     * @throws FileFormatException The file is empty
      */
     protected FileFormat(final File file) throws IOException, FileFormatException {
         this.fileName = file.getName();
@@ -129,6 +130,16 @@ public Collection<FileComponent> getFileComponents() {
         return Collections.unmodifiableCollection(this.components.values());
     }
 
+    /**
+     * The child class may choose to provide an icon for the file format. This
+     * method should be change to abstract if all children has provided an icon.
+     *
+     * @return <code>null</code> to use default icon, else use supplied icon
+     */
+    public Icon getIcon() {
+        return null;
+    }
+
     /**
      * Response to the tree node selection change event. Example: when choosing
      * method code node, the JVM Class file want to add a tab to display decoded

CommonLib/src/main/java/org/freeinternals/commonlib/core/PosDataInputStream.java

@@ -376,7 +376,7 @@ public String readASCII() throws IOException {
      * <code>end</code>.
      *
      * @param end
-     * @throws java.io.IOException
+     * @throws IOException
      *
      * <pre>
      * java:S135 - Loops should not contain more than a single "break" or "continue" statement --- We need it in this method
@@ -409,7 +409,7 @@ public String readASCIIUntil(final byte end) throws IOException {
      *
      * @param end End value for the ASCII string
      * @return ASCII as string
-     * @throws java.io.IOException Read failed
+     * @throws IOException Read failed
      *
      * <pre>
      * java:S135 - Loops should not contain more than a single "break" or "continue" statement --- We need it in this method
@@ -444,7 +444,7 @@ public String readASCIIUntil(byte... end) throws IOException {
      * {@link #NEWLINE_LF} flag found.
      *
      * @return
-     * @throws java.io.IOException
+     * @throws IOException
      */
     public ASCIILine readASCIILine() throws IOException {
         int nlLen = 1;

CommonLib/src/main/java/org/freeinternals/commonlib/ui/JTreeNodeFileComponent.java

@@ -93,8 +93,8 @@ public JTreeNodeFileComponent(final int nodeStartPos, final int nodeLength, fina
      */
     public JTreeNodeFileComponent(final int nodeStartPos, final int nodeLength, final String nodeText, final Icon nodeIcon, final String desc) {
         this(nodeStartPos, nodeLength, nodeText);
+        this.setIcon(nodeIcon);
         this.description = desc;
-        this.icon = nodeIcon;
     }
 
     @Override
@@ -155,7 +155,9 @@ public Icon getIcon() {
      * @param icon value for {@link #icon}
      */
     public void setIcon(Icon icon) {
-        this.icon = icon;
+        if (icon != null) {
+            this.icon = icon;
+        }
     }
 
     /**

CommonLib/src/main/java/org/freeinternals/commonlib/ui/UITool.java

@@ -8,6 +8,7 @@
 
 import java.awt.BorderLayout;
 import javax.swing.Icon;
+import javax.swing.ImageIcon;
 import javax.swing.JDialog;
 import javax.swing.JFrame;
 import javax.swing.JPanel;
@@ -58,12 +59,65 @@ public static void generateTreeNodeDiff(
     }
 
     /**
-     * Get Java system default icon for shortcut.
+     * Icon for counter.
      *
-     * @return Shortcut icon in Java
+     * @return Icon for counter
+     * @see <a href="https://icons8.com/icon/2U6ROkjIrXIA/abacus">Abacus</a> icon by <a href="https://icons8.com">Icons8</a>
      */
-    public static Icon getShortcutIcon() {
-        return UIManager.getIcon("InternalFrame.maximizeIcon");
+    public static Icon icon4Counter() {
+        return new ImageIcon(UITool.class.getResource("/image/icons8-abacus-16.png"));
+    }
+
+    /**
+     * Icon for DEX file.
+     *
+     * @return Icon for dex file
+     * @see <a href="https://icons8.com/icon/38933/apk">APK</a> icon by <a href="https://icons8.com">Icons8</a>
+     */
+    public static Icon icon4Dex() {
+        return new ImageIcon(UITool.class.getResource("/image/icons8-apk-20.png"));
+    }
+
+    /**
+     * Icon for Java.
+     *
+     * @return Icon for Java
+     */
+    public static Icon icon4Java() {
+        return new ImageIcon(UITool.class.getResource("/image/icons8-java-20.png"));
+    }
+
+    /**
+     * Icon for magic number.
+     *
+     * @return Icon for magic number
+     * @see <a href="https://icons8.com/icon/q8t3iE9rg6YF/magic-wand">Magic Wand</a> icon by <a href="https://icons8.com">Icons8</a>
+     */
+    public static Icon icon4Magic() {
+        return new ImageIcon(UITool.class.getResource("/image/icons8-magic-wand-16.png"));
+    }
+
+    /**
+     * Icon for shortcut.
+     *
+     * @return Shortcut icon
+     *
+     * @see <a href="https://icons8.com/icon/78265/shortcut">Shortcut</a> icon
+     * by <a href="https://icons8.com">Icons8</a>
+     */
+    public static Icon icon4Shortcut() {
+        return new ImageIcon(UITool.class.getResource("/image/icons8-shortcut-16.png"));
+    }
+
+    /**
+     * Icon for version.
+     *
+     * @return Icon for versions
+     * @see <a href="https://icons8.com/icon/21933/versions">Versions</a> icon by <a href="https://icons8.com">Icons8</a>
+     * @see <a href="https://icons8.com/icon/59954/versions">Versions</a> icon by <a href="https://icons8.com">Icons8</a>
+     */
+    public static Icon icon4Versions() {
+        return new ImageIcon(UITool.class.getResource("/image/icons8-versions-16.png"));
     }
 
     /**

CommonLib/src/main/resources/image/README.md

@@ -0,0 +1,3 @@
+Icons from [Icons8](https://icons8.com/)
+
+* Free version is avaible if [linking](https://icons8.com/pricing) is added