TweetFollow Us on Twitter

Jun 02 Cover Story

Volume Number: 18 (2002)
Issue Number: 06
Column Tag: Java Programming

by Andrew S. Downs

Dock Tile Imaging

Changing a Java application’s dock tile at runtime

Overview

The Dock Manager API allows a programmer to alter the tile for an application at runtime. Using the Java Native Interface, a Java application can change its tile dynamically as well. This involves a combination of Java and native code.

Two approaches are illustrated in this article. The first captures the pixels from a Java image and passes them to a native library function, which uses the CoreGraphics (Quartz) API to replace the application’s tile (see Figure 1).


Figure 1. A modified Dock tile.

The second example uses QuickDraw to paint a progress bar over the tile, as shown in Figure 2. The progress data is sent from Java to a native library function, and the imaging is done in the library.


Figure 2. The progress bar at the bottom of the tile, showing 60% complete.

If you want to code along with the examples, my recommendation is to first download the JNISample project from Apple’s developer site (see the URLs at the end of this article). That project served as the structural basis for the code in this article. All the build settings are already in place, making it an easy-to-use learning tool. (There are targets for compiling both the Java and native code, generating the javah file, building a library, etc.) I kept the filenames the same, but replaced the content of the various files. In the listings below you will see the filenames as they exist in that project.

Java

One class (DockTiler) provides most of the functionality for this example. It relies on two other classes for getting and drawing (offscreen) an image from a local file. You can also load an image via a non-local URL, which would allow the app to change the tile in response to outside conditions. For example, an application that retrieves weather data can change the tile to reflect current conditions or the forecast.

The JNISample class contains main(), the entry point for the Java application. It is used simply to instantiate DockTiler and invoke one of its instance methods.

Listing 1: JNISample.java

JNISample
The classes contained here include:
   JNISample: creates and calls a DockTiler instance.
   DockTiler: loads the image and sends it to the native drawing code.
   LocalFiler: allows the user to select a local file for display in the tile.
   PictureFrame: an offscreen Canvas which draws the image, allowing DockTiler
    to retrieve the image pixels.

// The image support comes from the AWT and the image package. 
import java.awt.*;
import java.awt.image.*;
import java.util.*;

public class JNISample {
   public JNISample() {}

   // Test code.
   public static void main (String args[]) {
      DockTiler dock = new DockTiler();
        
      dock.test();

      System.out.println( “Finished.” );
   }
}

class DockTiler {
   // If we have trouble loading an image, the values of its width and height will 
   // remain at -1. See loadImage().
   int mWidth = -1, mHeight = -1;
   int mPixels[];

   static {
      // Load the library when this class gets loaded.
      System.loadLibrary( “Example” );
   }

   public DockTiler() {
   }
   
   // These are the two functions in the shared library that we will call.
   // Note the declaration as native.
   native void setDockTile( int[] pixels, int width, 
      int height );

   native void updateProgressBar( int currPercent );
   
   // The primary test driver.
   public void test() {
      loadImage();
      
      setDockTile( mPixels, mWidth, mHeight );

      performTask();
   }

   // Read in the image and retrieve its pixels.
   protected void loadImage() {
      LocalFile lf = new LocalFile();
      String filename = lf.getFilePath();
      
      Image image = 
         Toolkit.getDefaultToolkit().getImage( filename );

      // Send the image to the Canvas, where it will be rendered.
      PictureFrame pf = new PictureFrame( image );
      
      Frame f = new Frame( “Image” );

      // Setup offscreen.
      f.setBounds( -250, -250, 200, 200 );

      f.setLayout( new BorderLayout() );
      f.add( “Center”, pf );
      pf.setSize( 128, 128 );
      f.pack();

      // An invisible window won’t render an image.
      f.setVisible( true );

      f.repaint();
      pf.repaint();
      
      // Use the Canvas as the observer during the loading process.
      int width = image.getWidth( pf );
      int height = image.getHeight( pf );
      
      // Allocate storage for the image data.
      mPixels = new int[ width * height ];
         
      // Create an object to copy the image pixel data into our array.
      PixelGrabber pg = new PixelGrabber( image, 0, 0, 
         width, height, mPixels, 0, width );
         
      // Copy the pixels to the array.
      try {
         pg.grabPixels();
      
         // Check for error using bit values in the ImageObserver class.
         if ( ( pg.getStatus() & ImageObserver.ABORT ) != 0 )
            return;
            
         // If successful, set instance attributes to legitimate values (not –1).
         mWidth = width;
         mHeight = height;
      }
      catch ( InterruptedException e ) {
         return;
      }
   }

   // For a task that may take some time, it helps to wrap it in a separate method or
   // even class, and spin it off as a thread. Here, simply get the current progress
   // and display it.
   protected void performTask() {
      int percentComplete = 0;
      
      boolean taskComplete = false;
      
      while ( !taskComplete ) {
         // Call the native method that draws the progress bar.
         updateProgressBar( percentComplete );
         
         percentComplete = updateTask();
         
         if ( percentComplete >= 100 )
            taskComplete = true;
      }
   }

   int mCount = 0;
   
   // Lengthy tasks will use a sophisticated approach to determining completion.
   // This example uses a simple loop so we can watch the bar move.
   protected int updateTask() {
      return mCount++;
   }
}

class LocalFile {
   FileDialog mFileDialog = null;
   
   // Display a dialog asking the user to choose a file.
   public LocalFile() {
      if ( mFileDialog == null ) {
         mFileDialog = new FileDialog( new Frame(), 
            “Select an image file”, FileDialog.LOAD );
      }
   }
   
   // Build and return the path to the file (if selected).
   public String getFilePath() {
      mFileDialog.setVisible( true );
      
      String retval = “”;
      
      if ( mFileDialog.getFile() != null && 
         mFileDialog.getFile().length() > 0 ) {
         retval = mFileDialog.getDirectory();
         
         if ( !retval.endsWith( 
            System.getProperty( “file.separator” ) ) )
            retval += System.getProperty( “file.separator” );
         
         retval += mFileDialog.getFile();
      }
      
      return retval;
   }
}

// A subclass of java.awt.Canvas that draws an Image object.
class PictureFrame extends Canvas {
   Image mImage;
   
   PictureFrame( Image img ) {
      super();
      mImage = img;
      setBackground( Color.white );
   }
   
   public void update( Graphics g ) {
      paint( g );
   }
   
   // Draw the image.
   public void paint( Graphics g ) {
      g.drawImage( mImage, 0, 0, this );
   }
}

Java Native Interface Code

JNI code is C code that bridges the Java and native worlds, handling the conversion between Java data types and their native counterparts. The JNIEnv pointer in each function indirectly points to a function table containing JNI functions, and the jobject references the instance of the class making the call. Any additional arguments are the values passed from the Java code to the native code.

Listing 2: ExampleJNILib.c

ExampleJNILib
The JNI glue for converting arguments prior to calling through to the native code.

#include “JNISample.h”
#include “ExampleDylib.h”

JNIEXPORT void JNICALL Java_DockTiler_setDockTile( 
   JNIEnv *env, jobject this, jintArray pixels, jint width, 
   jint height ) {
   // Obtain a pointer to the array to pass to the native function.
   jint *theArray = (*env)->GetIntArrayElements( 
      env, pixels, NULL );

   if ( theArray != NULL ) {
      // Call the library function.
      // Note that no adjustments are made to the primitive values.
      setDockTile( theArray, width, height );
  
      // Tell the VM we are no longer interested in the array.
      (*env)->ReleaseIntArrayElements( env, pixels, theArray, 
         0 );
   }
}

JNIEXPORT void JNICALL Java_DockTiler_updateProgressBar( 
   JNIEnv *env, jobject this, jint currPercent ) {
   // Call the library function.
   // No additional translation is needed on primitive values.
   updateProgressBar( currPercent );
}

The Library

The native library contains the actual tile drawing code. One function creates an image and replaces the existing tile with the new one. The second function uses a completion percentage value to determine how much of the progress bar to paint. It draws over the bottom of the existing tile.

Listing 3: ExampleDylib.c

ExampleDylib.c
Perform drawing in the Dock tile.

#include 
#include 
#include 

// Args include the array of pixel RGBA values, and the actual image width and height.
extern void setDockTile( int * imagePixels, int width, 
   int height ) {
   // How many bytes in each pixel? Java uses 4-byte ints.
   int kNumComponents = 4;
   
   OSStatus   theError;

   // Several CoreGraphics variables.
   CGContextRef theContext;
   CGDataProviderRef theProvider;
   CGColorSpaceRef theColorspace;
   CGImageRef theImage;

   // How many bytes in each row?
   size_t bytesPerRow = width * kNumComponents;

   // Obtain graphics context in which to render.
   theContext = BeginCGContextForApplicationDockTile();

   if ( theContext != NULL ) {   
      // Use the pixels passed in as the image source.
      theProvider = CGDataProviderCreateWithData( 
         NULL, imagePixels, ( bytesPerRow * height ), NULL );
   
      theColorspace = CGColorSpaceCreateDeviceRGB();
      
      // Create the image. This is similar to creating a PixMap. 
      // - The width and height were passed as arguments. 
      // - The next two values (8 and 32) are the bits per pixel component and 
      //    total bits per pixel, respectively. 
      // - bytesPerRow was calculated above. 
      // - Use the colorspace ref obtained previously. 
      // - The alpha or transparency data is in the first byte of each pixel. 
      // - Use the data source created a few lines above.
      // - The remaining parameters are typical defaults. Consult the API docs for 
      //    more info.
      theImage = CGImageCreate( width, height, 8, 32, 
         bytesPerRow, theColorspace, kCGImageAlphaFirst, 
         theProvider, NULL, 0, kCGRenderingIntentDefault );
   
      CGDataProviderRelease( theProvider );
      CGColorSpaceRelease( theColorspace );
      
      // Set the created image as the tile.
      theError = SetApplicationDockTileImage( theImage );

      CGContextFlush( theContext );
   
      CGImageRelease( theImage );

      EndCGContextForApplicationDockTile( theContext );
   }
}

extern void updateProgressBar( const int currPercent ) {
   CgrafPtr thePort;
   Rect   theRect;
   float   right = 0;
   
   // Obtain graphics context.
   thePort = BeginQDContextForApplicationDockTile();

   if ( thePort != NULL ) {
      // Good ol’ QuickDraw.
      GetPortBounds( thePort, &theRect );
      
      // Initially, draw the background of the bar and frame it.
      if ( currPercent == 0 ) {
         SetRect( &theRect, theRect.left, theRect.bottom - 10, 
            theRect.right, theRect.bottom );
         ForeColor( redColor );
         PaintRect( &theRect );
         ForeColor( blackColor );
         FrameRect( &theRect );
      }
      
      // Calculate right-edge of progress bar.
      if ( currPercent >= 100 )
         right = ( float )theRect.right;
      else
         right = ( ( ( float )theRect.right – 
            ( float )theRect.left ) / 
            ( float )100 ) * ( float )currPercent;

      // Draw the entire progress bar up until this point.
      ForeColor( greenColor );

      // Inset the progress rectangle on our own.
      SetRect( &theRect, theRect.left + 1, 
         theRect.bottom - 9, ( int )right, 
         theRect.bottom - 1 );

      PaintRect( &theRect );

      QDFlushPortBuffer( thePort, NULL );

      EndQDContextForApplicationDockTile( thePort );
   }
}

The image creation using the CoreGraphics API is the trickiest part. This example uses the fact that a Java int is 4 bytes, and that alpha (transparency) data, if included, is stored in the most significant byte. After some trial and error, I found that the settings shown here work for the images I tested against.

Useful URLs

I used quite a few outside sources (primarily Apple) in preparing this article. Though some of these URLs may change, I want to at least point you in the right direction.


Andrew has been a Java fan since his first encounter with the language at the WebEdge III conference in 1996. You can reach him at andrew@downs.ws.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Apple Remote Desktop 3.8 - Remotely cont...
Apple Remote Desktop is the best way to manage the Mac computers on your network. Distribute software, provide real-time online help to end users, create detailed software and hardware reports, and... Read more
NeoOffice 2014.7 - Mac-tailored, OpenOff...
NeoOffice is a complete office suite for OS X. With NeoOffice, users can view, edit, and save OpenOffice documents, PDF files, and most Microsoft Word, Excel, and PowerPoint documents. NeoOffice 3.x... Read more
DesktopLyrics 2.6.6 - Displays current i...
DesktopLyrics is an application that displays the lyrics of the song currently playing in "iTunes" right on your desktop. The lyrics for the song have to be set in iTunes; DesktopLyrics does nothing... Read more
Ember 1.8.3 - Versatile digital scrapboo...
Ember (formerly LittleSnapper) is your digital scrapbook of things that inspire you: websites, photos, apps or other things. Just drag in images that you want to keep, organize them into relevant... Read more
Apple iTunes 12.1 - Manage your music, m...
Apple iTunes lets you organize and play digital music and video on your computer. It can automatically download new music, app, and book purchases across all your devices and computers. And it's a... Read more
LibreOffice 4.4.3 - Free, open-source of...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
FoldersSynchronizer 4.2.1 - Synchronize...
FoldersSynchronizer is a popular and useful utility that synchronizes and backs-up files, folders, disks and boot disks. On each session you can apply special options like Timers, Multiple Folders,... Read more
Simon 4.0.2 - Monitor changes and crashe...
Simon monitors websites and alerts you of crashes and changes. Select pages to monitor, choose your alert options, and customize your settings. Simon does the rest. Keep a watchful eye on your... Read more
Cocktail 8.1.2 - General maintenance and...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Cyberduck 4.6.4 - FTP and SFTP browser....
Cyberduck is a robust FTP/FTP-TLS/SFTP browser for the Mac whose lack of visual clutter and cleverly intuitive features make it easy to use. Support for external editors and system technologies such... Read more

Playworld Superheroes Review
Playworld Superheroes Review By Tre Lawrence on January 30th, 2015 Our Rating: :: HERO CRAFTINGUniversal App - Designed for iPhone and iPad It’s all about the imagination, fighting bad creatures — and looking good while doing so.   | Read more »
Join the SpongeBob Bubble Party in this...
Join the SpongeBob Bubble Party in this New Match 3 Bubble Poppin’ Frenzy Posted by Jessica Fisher on January 30th, 2015 [ permalink ] | Read more »
Handpick Review
Handpick Review By Jennifer Allen on January 30th, 2015 Our Rating: :: TANTALIZING SUGGESTIONSiPhone App - Designed for the iPhone, compatible with the iPad Handpick will make you hungry, as well as inspire you to cook something... | Read more »
Storm the Halls of Echo Base in First St...
Storm the Halls of Echo Base in First Star Wars: Galactic Defense Event Posted by Jessica Fisher on January 30th, 2015 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Contradiction Review
Contradiction Review By Tre Lawrence on January 30th, 2015 Our Rating: :: SPOT THE LIEiPad Only App - Designed for the iPad Contradiction is a live action point and click adventure that’s pretty engaging.   Developer: Tim Follin... | Read more »
Unlock Sunshine Girl in Ironkill with th...
Unlock Sunshine Girl in Ironkill with this special 148Apps code Posted by Rob Rich on January 29th, 2015 [ permalink ] Robo-fighter Ironkill has been out on iOS a | Read more »
Crossroad Zombies Review
Crossroad Zombies Review By Jordan Minor on January 29th, 2015 Our Rating: :: CROSSWALKING DEADiPad Only App - Designed for the iPad Crossroad Zombies is a rough draft of a cool genre mash-up.   | Read more »
Blood Brothers 2 – Tips, Cheats, and Str...
War is hell: Is it the kind of hell you want to check out? Read our Blood Brothers 2 review to find out! Blood Brothers 2, DeNA’s follow-up to the original Blood Brothers, is an intriguing card collecting / role-playing / strategy hybrid. There’s... | Read more »
Blood Brothers 2 Review
Blood Brothers 2 Review By Nadia Oxford on January 29th, 2015 Our Rating: :: AN AGGRAVATING RELATIVEUniversal App - Designed for iPhone and iPad Blood Brothers 2 is built on a simple, solid foundation, but its free-to-play system... | Read more »
I AM BREAD, the Toast of the Town, is Ro...
Have you ever dreamt of being deliciously gluten-y? Do you feel passionate about Rye and Wheat? The guys at Bossa Studios do and that is why they are bringing I AM BREAD to iOS soon. The loafy app will feature all the new content that is being... | Read more »

Price Scanner via MacPrices.net

Intel Aims to Transform Workplace With 5th-Ge...
Intel Corporation today announced the availability of its 5th generation Intel Core vPro processor family that provides cutting-edge features to enable a new and rapidly shifting workplace. To meet... Read more
iOS App Sharalike Introduces New Instant Smar...
Sharalike slideshow and photo management software for iOS, is making it easier than ever to create shareable meaningful moments with its new instant SmartShow technology. Staying organized is a goal... Read more
Apple Becomes World’s Largest Smartphone Vend...
According to the latest research data from Strategy Analytics, as global smartphone shipments grew 31 percent annually to reach a record 380 million units in the fourth quarter of 2014. Apple became... Read more
Cut the Cord: OtterBox Resurgence Power Case...
Dead batteries and broken phones are two of the biggest issues for smartphone users today. Otterbox addresses both with the new Resurgence Power Case for Apple iPhone 6, promising to make those panic... Read more
13-inch Retina MacBook Pros on sale for up to...
B&H Photo has 13″ Retina MacBook Pros on sale for $200 off MSRP. Shipping is free, and B&H charges NY sales tax only: - 13″ 2.6GHz/128GB Retina MacBook Pro: $1199.99 save $100 - 13″ 2.6GHz/... Read more
15-inch 2.5GHz Retina MacBook Pro on sale for...
 B&H Photo has the 15″ 2.5GHz Retina MacBook Pro on sale for $2319.99 including free shipping plus NY sales tax only. Their price is $180 off MSRP, and it’s the lowest price available for this... Read more
Back in stock: Refurbished iPod nanos for $99...
The Apple Store has Apple Certified Refurbished 16GB iPod nanos available for $99 including free shipping and Apple’s standard one-year warranty. That’s $50 off the cost of new nanos. Most colors are... Read more
Apple lowers price on refurbished 256GB MacBo...
The Apple Store has lowered prices on Apple Certified Refurbished 2014 MacBook Airs with 256GB SSDs, now available for up to $200 off the cost of new models. An Apple one-year warranty is included... Read more
New Good Management Suite Simplifies Enterpri...
Good Technology has announced the availability of the Good Management Suite, a comprehensive cross-platform solution for organizations getting started with mobile business initiatives. Built on the... Read more
15-inch 2.0GHz Retina MacBook Pro (refurbishe...
The Apple Store has Apple Certified Refurbished previous-generation 15″ 2.0GHz Retina MacBook Pros available for $1489 including free shipping plus Apple’s standard one-year warranty. Their price is... Read more

Jobs Board

At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
Sr. Mac Expert- *Apple* Online Store - Apple...
**Job Summary** The World Wide Apple Online Store (AOS) Sales and Service team is looking for motivated, outgoing, and tech savvy individuals who want to offer Apple Read more
*Apple* Solutions Consultant- Retail Sales (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Event Director, *Apple* Retail Marketing -...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global engagement strategy and team. Delivering an overarching brand Read more
At-Home Chat Specialist- *Apple* Online Stor...
**Job Summary** At Apple , we believe in hard work, a fun environment, and the kind of creativity and innovation that only comes about when talented people from diverse Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.