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.

 
AAPL
$104.88
Apple Inc.
+1.89
MSFT
$44.77
Microsoft Corpora
+0.39
GOOG
$544.90
Google Inc.
+12.19

MacTech Search:
Community Search:

Software Updates via MacUpdate

jAlbum Pro 12.2.4 - Organize your digita...
jAlbum Pro has all the features you love in jAlbum, but comes with a commercial license. With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code!... Read more
jAlbum 12.2.4 - Create custom photo gall...
With jAlbum, you can create gorgeous custom photo galleries for the Web without writing a line of code! Beginner-friendly, with pro results Simply drag and drop photos into groups, choose a design... Read more
ExpanDrive 4.1.7 - Access remote files o...
ExpanDrive builds cloud storage in every application, acts just like a USB drive plugged into your Mac. With ExpanDrive, you can securely access any remote file server directly from the Finder or... Read more
OmniOutliner Pro 4.1.3 - Pro version of...
OmniOutliner Pro is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It'... Read more
Evernote 5.6.2 - Create searchable notes...
Evernote allows you to easily capture information in any environment using whatever device or platform you find most convenient, and makes this information accessible and searchable at anytime, from... Read more
OmniOutliner 4.1.3 - Organize your ideas...
OmniOutliner is a flexible program for creating, collecting, and organizing information. Give your creativity a kick start by using an application that's actually designed to help you think. It's... Read more
BBEdit 11.0 - Powerful text and HTML edi...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
Apple Security Update 2014-005 - For OS...
Apple Security Update is recommended for all users and improves the security of Mac OS X. For information on the security content of this update, please visit this website: http://support.apple.com/... Read more
EyeTV 3.6.6 - Watch and record TV on you...
EyeTV brings a rich TV experience to your Mac. Watch live TV on your Mac. Pause, rewind, and record whenever you want. EyeTV gives you powerful control over what you watch and how you watch it. Put... Read more
RapidWeaver 6.0 - Create template-based...
RapidWeaver is a next-generation Web design application to help you easily create professional-looking Web sites in minutes. No knowledge of complex code is required, RapidWeaver will take care of... Read more

Latest Forum Discussions

See All

Garruk Gets His Revenge in a New Magic 2...
Garruk Gets His Revenge in a New Magic 2015 Expansion, Coming This November Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] | Read more »
Sentinels of the Multiverse Review
Sentinels of the Multiverse Review By Rob Thomas on October 23rd, 2014 Our Rating: :: SENTINELS ASSEMBLEiPad Only App - Designed for the iPad Greater Than Games’ tabletop classic, Sentinels of the Multiverse swoops in to save the... | Read more »
Build Your Own Fantasy Football Dynasty...
Build Your Own Fantasy Football Dynasty with Draft Day Posted by Jessica Fisher on October 23rd, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Cars: Fast as Lightning – Tips, Tricks,...
Hey there, Stickers: Want to know all about how impressed we were with Radiator Springs? Check out our Cars: Fast as Lightning review! Cars: Fast as Lightning is a cute and fun app that combines racing and town-building with the charisma and... | Read more »
Jam Messenger Review
Jam Messenger Review By Jennifer Allen on October 23rd, 2014 Our Rating: :: SIMPLE MESSAGINGiPhone App - Designed for the iPhone, compatible with the iPad Want a very quick way to send push-based messages? Jam Messenger is basic... | Read more »
Felllice (Games)
Felllice 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: EXCLUSIVE PRICE DROP! 50% OFF FOR A LIMITED TIME! EAT EAT EAT AND GROW ! | Read more »
The Arrow Game: by Grazie Media (Games)
The Arrow Game: by Grazie Media 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Guide a flying arrow through skyscrapers and city streets to hit a distant target. Experience an endless... | Read more »
Worldly (Games)
Worldly 1.2 Device: iOS Universal Category: Games Price: $2.99, Version: 1.2 (iTunes) Description: | Read more »
Money Pro - EASY! Bills, Budgets and Acc...
Money Pro - EASY! Bills, Budgets and Accounts w/ Sync 1.0 Device: iOS Universal Category: Finance Price: $4.99, Version: 1.0 (iTunes) Description: Manage money like a pro. Money Pro is the next generation of Money app (over 2 million... | Read more »
Pro Strategy Football 2014 (Games)
Pro Strategy Football 2014 2014.141001 Device: iOS Universal Category: Games Price: $4.99, Version: 2014.141001 (iTunes) Description: Take the proven strategy of the PSF franchise and add in Casual Play, improved graphics and... | Read more »

Price Scanner via MacPrices.net

Apple refurbished Time Capsules available sta...
The Apple Store has certified refurbished Time Capsules available for up to $60 off MSRP. Apple’s one-year warranty is included with each Time Capsule, and shipping is free: - 2TB Time Capsule: $255... Read more
Textilus New Word, Notes and PDF Processor fo...
Textilus is new word-crunching, notes, and PDF processor designed exclusively for the iPad. I haven’t had time to thoroughly check it out yet, but it looks great and early reviews are positive.... Read more
WD My Passport Pro Bus-Powered Thunderbolt RA...
WD’s My Passport Pro RAID solution is powered by an integrated Thunderbolt cable for true portability and speeds as high as 233 MB/s. HighlightsOverviewSpecifications Transfer, Back Up And Edit In... Read more
Save with Best Buy’s College Student Deals
Take an additional $50 off all MacBooks and iMacs at Best Buy Online with their College Students Deals Savings, valid through November 1st. Anyone with a valid .EDU email address can take advantage... Read more
iPad Air 2 & iPad mini 3 Best Tablets Yet...
The new iPads turned out to be pretty much everything I’d been hoping for and more than I’d expected.”More” particularly in terms of a drinking-from-a-firehose choice of models and configurations,... Read more
Drafts 4 Reinvents iOS Productivity App
N Richland Hills, Texas based Agile Tortoise has announced the release of Drafts 4 for iPhone and iPad. Drafts is a quick capture note taking app with flexible output actions. Drafts 4 scales from... Read more
AT&T accepting preorders for new iPads fo...
AT&T Wireless is accepting preorders for the new iPad Air 2 and iPad mini 3, cellular models, for $100 off MSRP with a 2-year service agreement: - 16GB iPad Air 2 WiFi + Cellular: $529.99 - 64GB... Read more
Apple offering refurbished Mac Pros for up to...
The Apple Store is offering Apple Certified Refurbished 2013 Mac Pros for up to $600 off the cost of new models. An Apple one-year warranty is included with each Mac Pro, and shipping is free. The... Read more
Select MacBook Airs $100 off MSRP, free shipp...
B&H Photo has 2014 a couple of MacBook Airs on sale for $100 off MSRP. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels Desktop and LoJack for... Read more
13-inch 2.5GHz MacBook Pro on sale for $100 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $999.99 including free shipping plus NY sales tax only. Their price is $100 off MSRP. Read more

Jobs Board

Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**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
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.