TweetFollow Us on Twitter

Printing One Page Reports

Volume Number: 19 (2003)
Issue Number: 10
Column Tag: Programming

Printing One Page Reports

How to accomplish simple program controlled printing in Cocoa

by Clark Jackson

This is another article directed at the enterprise. The enterprise because it is there that you often find the need for one page reporting of many stripes. Many enterprise reports have data from disparate sources scattered over the page but yet are not complex enough to demand an NSDocument based application. Using Interface Builder makes the layout of one page reports easy so all is well-that is, until you need to print that report. Yes, you can tell any NSView to print itself but that doesn't help too much if the views print individually. And, what if you want to bypass the print dialog and have the output scaled and the orientation landscape? This tip is meant to provide the needed information to print simple reports where page breaking is not involved.

Topics

  • Managing view hierarchy

  • Collecting views for printing

  • Benefits of subclassing NSWindowController

  • Anatomy of frames

  • Moving and resizing views

  • Specifying margins, orientation, scaling, paper, and copies

  • Bypassing the print panel

  • Mid-code variable declarations

  • Argument-passing timers

Arranging Views

The window of our sample program is presented in Figure 1. It contains information we want to print and information we don't want to print including various UI elements. Its orientation is portrait but the information we want printed is better suited to landscape and it's too big to fit on one printed page. The Page Setup... command allows us to control the scale but when we adjust it to fill the page, the default too-wide margins prevent us from doing so. Finally, we'd like the report to print just after midnight when no users are present.


Figure 1. The window containing our report.

The simple approach to one page printing is to tell the window to print itself: [[someReportUIElement window]print:nil]; where someReportUIElement is any user interface element that is in the report window. The nice thing here is that windows seem to scale and orient themselves automatically to fit a page the best way. The drawback here is that a window printing itself includes its title bar and the window's background horizontal gray pinstripes. The pinstriping can be handled permanently or during a print by the following:

[[someReportUIElement window]setBackgroundColor:
[NSColor whiteColor]];
[[someReportUIElement window] print:nil];
[[someReportUIElement window]setBackgroundColor:
[NSColor windowBackgroundColor]]; // restores pinstripe

Another way to easily print a one page report would be to tell the window to print its contents thus eliminating the title bar and gray pinstripe: [[[someReportUIElement window]contentView]print:nil];. The drawback here is that the scaling and orientation don't calculate automatically and our other objectives remain unmet.

It should be noted here that if your controller is subclassed from an NSWindowController then the print statement can be: [[self window]print:nil]; or [[[self window] contentView]print:nil]; (remember to make the connection in IB between the window and the controller's "window" outlet!). Subclassing NSWindowController has the added benefit of having windowWillClose: being called on it automatically (by making the controller the window's delegate in IB) so that you can release your resources when the window is closed. Releasing your controller is not an issue for simple apps that only have one controller; however, with more complicated applications with many controllers that come and go, windowWillClose: is one way to be notified when your window's controller can be released.

The most flexible solution to printing views together is to provide a faceless background superview and tell it to print itself including its subviews. A likely candidate view for this purpose is an NSBox. Start by dragging an NSBox onto our window in IB. Make it big enough to cover the area you want printed. A custom view in IB would serve as well but the NSBox has the added ability to draw a border and a title if you should want them. The inspector in IB doesn't give you the options to specify where the title appears but you can do it programmatically. Possible constants are NSNoTitle, NSAboveTop, NSAtTop, NSBelowTop, NSAboveBottom, NSAtBottom, and NSBelowBottom.

Any element you want to print along with your NSBox view has to be a subview of that NSBox view. You can assign UI elements to be subviews of the NSBox view either in IB or programmatically. In order to assign them in IB, drag your NSBox view onto the window first. Then drag the other elements you want printed from the palette on top of the NSBox (you will see the NSBox view highlight).

If you choose to assign elements programmatically it takes a little more work because you have to assign a new frame location. Let's say you place an NSBox view on your window after placing an NSTextField. You send the NSBox view to the back and put the NSTextField on top. The NSBox view doesn't highlight as you drag NSTextField on top of it because the NSTextField hasn't come directly off the palette. As a result, the NSTextField does not become a subview of the NSBox view. To fix this situation in your program you would make the NSTextField (fNotSubviewTextField) a subview of your NSBox (fBox), in this way: [[fBox contentView] addSubview:fNotSubviewTextField];. Unfortunately, our work is not done because fNotSubviewTextField keeps its frame attributes from its previous superview (the window) and applies them to the new superview (the fBox) most likely causing fNotSubviewTextField to disappear by being outside the clipping area of fBox. (By the way, variables starting with "f" indicate an instance variable, a holdover from my old MacApp days.) Preserve fNotSubviewTextField's location (so it is not clipped) relative to the window in this way:

NSRect originalTextFieldFrame = [fNotSubviewTextField frame]; // get the original frame based on the window being the superview

[[fBox contentView] addSubview: fNotSubviewTextField]; // move the text field to 
   the box view for printing
NSRect newTextFieldFrame = originalTextFieldFrame; // copy original frame into new, later to 
   change origin not size
// make allowance for the NSBox's border
float xAdj = 0.0;
float yAdj = 0.0;
if([fBox borderType] == NSLineBorder) xAdj = yAdj = 1.0;
else if([fBox borderType] == NSBezelBorder || [fBox borderType] == NSGrooveBorder) xAdj = yAdj = 2.0;
boxFrame = [fBox frame]; // get the new superview's frame
// calculate the new frame using the difference between the original and new superview frames
newTextFieldFrame.origin.x = originalTextFieldFrame.origin.x - boxFrame.origin.x - xAdj; 
newTextFieldFrame.origin.y = originalTextFieldFrame.origin.y - boxFrame.origin.y - yAdj;
[fNotSubviewTextField setFrame:newTextFieldFrame];  // give the text field its new frame in terms of 
   it's new superview

The frame method of an NSView returns an NSRect structure that defines its position in its superview. For those of you new to Cocoa, not all names preceded by "NS" refer to Objective C objects, some like NSRect, NSSize, NSPoint, and NSRange are C structures and therefore have elements that are accessible via the . syntax, i.e. NSPoint center.x = [fBox frame].size.width / 2.0; works just fine. Figure 2 illustrates the hierarchy.


Figure 2. The anatomy of a view's frame.

Now fNotSubviewTextField will print (inspite of its name!), having programmatically become a subview of fBox, when fBox is told to print. The next problem to resolve is subviews of fBox that you don't want to print. Figure 1 shows a few elements inside of fBox that we don't want to print: fRunButton, fPrintButton, and fProgressIndicator. Notice we do not include the fAuto check box in this list because even though it appears on top of fBox it is not a subview of fBox and therefore will not print with fBox. Until Panther ships, which adds the ability to hide NSViews, we will have to programmatically move unwanted views outside the clipping bounds of fBox before printing--and put them back after.

In order to move our views around conveniently we'll use a two step process. First, we'll set up the off-view set of frames one time when our program launches and second, we'll provide a method that swaps the frames back and forth. We'll need an instance variable array of the UI element frames, fRelocatableFrames. When awakeWithNib is called we specify the NSRect's that are initially the off-view frames for fBox's subviews that we don't want to print. Since NSRect's are not objects we'll need to reference them in the array by index so we enumerate an index as well. The final thing we'll need is an array of the affected UI elements, fRelocatableObjects. This array will be used in the method that swaps the frames of the objects.

// make a list of all the views that you want relocated, resized, or hidden during printing
typedef enum
{    kRunButton,
   kPrintButton,
   fProgressIndicator,
   kRelocateTextField
} ElementsToHideWhilePrinting;
// populate fRelocatableFrames so designated user interface elements can be hidden 
   or relocated during printing
   
NSSize myOffViewSize;
NSPoint myOffViewLocation;
myOffViewLocation.x = 1700.0; // an arbitrary off-view location
myOffViewLocation.y = 1700.0;
fRelocatableFrames[kRunButton].origin = myOffViewLocation; // remember off-view location
fRelocatableFrames[kRunButton].size = [fTextView frame].size; // remember original size
...
// fTextView will be different from the others in that we still want it to print 
   but at a different location and size
   
   myOffViewSize.height = 65.0;
   myOffViewSize.width = 200.0;
   myOffViewLocation.x = 320.0;
   myOffViewLocation.y = [fBox frame].size.height - myOffViewSize.height - 20.0;
   fRelocatableFrames[kRelocateTextField].origin = myOffViewLocation;
   fRelocatableFrames[kRelocateTextField].size = myOffViewSize;
   // now that the new frames have been created, make a list of affected UI objects
   // so we can iterate over them swapping frames as we go
 fRelocatableObjects = [NSMutableArray arrayWithCapacity:5];
[fRelocatableObjects retain];
[fRelocatableObjects insertObject:fRunButton atIndex:kRunButton];
...

During program execution we need a method that will assign the new frames to the relocatable objects at the same time remembering the original locations and sizes so that they can be restored after printing:

swapFrames
This method conveniently handles the moving and resizing of any element during printing. It 
remembers the old location so the pre-printing state can be restored.
 
- (IBAction)swapFrames:(id)sender
{
   int theIndex, theNumberOfObjects;
   theNumberOfObjects = [fRelocatableObjects count];
   {
      // Why the brace? arrayOfNewFrames is declared below as an NSRect only after theNumberOfObjects 
         has been determined. Declaring new variables has to be done inside code blocks i.e. inside 
         braces, {}
         
      NSRect   arrayOfNewFrames[theNumberOfObjects];
      // make a copy of the relocateble frames
      for(theIndex = 0;theIndex < theNumberOfObjects;theIndex++)
      {
         arrayOfNewFrames[theIndex] = fRelocatableFrames[theIndex];
      }
      // put the existing frames of the relocatable objects into the fRelocatableFrames array, 
         these frames will be remembered here so that they can be swapped back in the future
      for(theIndex = 0;theIndex < theNumberOfObjects;theIndex++)
      {
         fRelocatableFrames[theIndex] = [[fRelocatableObjects objectAtIndex:theIndex]frame];
      }
      // now impose the new set of frames on the objects to be relocated/resized
      for(theIndex = 0;theIndex < theNumberOfObjects;theIndex++)
      {
         // to remove any vestige of the UI element once it has been moved
         [[[fRelocatableObjects objectAtIndex:theIndex] superview] setNeedsDisplayInRect:
            [[fRelocatableObjects objectAtIndex:theIndex] frame]];
         // assign the new frame
         [[fRelocatableObjects objectAtIndex:theIndex] setFrame:arrayOfNewFrames[theIndex]];
         // make sure it redraws itself after being moved
         [[fRelocatableObjects objectAtIndex:theIndex] setNeedsDisplay:YES];
      }
   }
   return;
}

The source includes another method, moveForm, that demonstrates moving an NSForm into fBox (making it an fBox subview) during printing and back out into the window again afterwards. By modifying the statements in these three methods, awakeFromNib, swapFrames, and moveForm you should be able to move, resize, hide, print, and afterwards restore any number of views that you have to meet any single page printing requirement.

Basic Printing

Once all our views are in place to print (or not print) we need a method that will direct fBox to print. fBox's output, our report, appears in Figure 3. The method in our program defaults to not using a print dialog, however, that ability remains at the user's discretion by using the option key. In the default no-user-interaction mode our method will specify page orientation, scale, margins, and number of copies. In order to print bypassing the user we instantiate an NSPrintInfo which contains all the print settings we need including margins and page orientation. You can choose to have the scaling be automatic to fit the page by using setHorizontalPagination:NSFitPagination or you can get the NSPrintInfo's dictionary and set the scaling directly. With that same dictionary you can specify the number of copies. Following is the source that encapsulates what you need for printing.

myPrintInfo = [[NSPrintInfo alloc] initWithDictionary:(NSMutableDictionary*)
   [[NSPrintInfo sharedPrintInfo]dictionary]];  
      // get a copy of the shared NSPrintInfo provided by the system
      // adjust the margins

[myPrintInfo setOrientation:NSLandscapeOrientation]; // alt: NSPortraitOrientation
[myPrintInfo setBottomMargin:30.0];
[myPrintInfo setLeftMargin:30.0];
[myPrintInfo setRightMargin:30.0];
[myPrintInfo setTopMargin:35.0];
// You can specify the paper name here, just make sure your printer has it for unattended printing
// [myPrintInfo setPaperName:@"Legal"];
// you can have scaling to be automatic here or set the scaling factor as shown below
// [myPrintInfo setHorizontalPagination:NSFitPagination];
// [myPrintInfo setVerticalPagination:NSFitPagination];
// set up the dictionary, get it from your NSPrintInfo
myPrintInfoDictionary = (NSMutableDictionary*)[myPrintInfo dictionary];
[myPrintInfoDictionary setObject:[NSNumber numberWithFloat:0.65] forKey:NSPrintScalingFactor];
[myPrintInfoDictionary setObject:[NSNumber numberWithInt:1] forKey:NSPrintCopies];
// Use either of these statements below to print the window or its contents respectively
//myPrintOperation = [NSPrintOperation printOperationWithView:[self window] printInfo:myPrintInfo];
//myPrintOperation = [NSPrintOperation printOperationWithView:[[self window] contentView] 
   printInfo:myPrintInfo];

// run your print job on fBox
myPrintOperation = [NSPrintOperation printOperationWithView:fBox printInfo:myPrintInfo];
[myPrintOperation setCanSpawnSeparateThread:YES];
[myPrintOperation setShowPanels:NO]; // don't want to see the panel
[myPrintOperation runOperation];
[myPrintInfo release]; // it was alloc'd so release it


Figure 3. fBox as printed, constituting our one page report.

Unattended Printing

The final thing to accomplish is to provide a means to print the report unattended. We accomplish this by using an NSTimer. As soon as you introduce a timer you need to think about the method it will be calling or invoking. If it is necessary to pass any parameters to your printing method from your timer then you will need to set up a printing method different from the one provided by IB that is linked to your Print button. The source demonstrates segregating printing functions by using printUnattendedWithScaling:andCopies:. This method has two parameters which the timer will provide at the time of unattended printing. It is also called by the UI Print button (with nil arguments) when the user selects to print without a print panel. Using an NSTimer is shown in the following method from the source:

createPrintTimer:
This method creates and releases a timer (when the user toggles the switch) that controls unattended 
printing at midnight. If you are new to NSTimer an interesting aspect is how arguments are passed to 
the method that is invoked by the timer. Also, creating and disposing of NSTimer's is shown. This 
timer is set to fire every 30 minutes. The printUnattendedWithScaling:andCopies: method does the 
checking to verify the time and whether or not the report has already printed once for the day.

- (void) createPrintTimer:(id)sender
{
   NSInvocation *printUnattendedInvocation;
   SEL theSelector;
   NSMethodSignature *aSignature;
   NSNumber *myTwo,*my65Percent;
   // these will be passed as arguments, arguments must be objects
   myTwo = [NSNumber numberWithInt:2];
   my65Percent = [NSNumber numberWithFloat:0.65];
   if(fPrintTimer) // timer already exists so dispose of it
   {
      if([fPrintTimer isValid])
      {
         fPrintTimer invalidate];
         [fPrintTimer release];
         fPrintTimer = nil;
      }
      else
      {
         NSLog(@"should never end up here where timer exists and is invalid");
      }
   }
   else // timer doesn't exit, create timer
   {
      // include line below if you want the method called as soon as the timer is turned on, timers 
         fire first time AFTER period has passed
      // [self printUnattendedWithScaling:my65Percent andCopies:myTwo];
      theSelector = @selector(printUnattendedWithScaling: andCopies:);
      aSignature = [MyWindowController instanceMethodSignatureForSelector:theSelector];
      printUnattendedInvocation = [NSInvocation invocationWithMethodSignature:aSignature];
      [printUnattendedInvocation setSelector:theSelector];
      [printUnattendedInvocation setTarget:self];
      [printUnattendedInvocation setArgument:&my65Percent atIndex:2]; // index 2 is where arguments 
         to the method begin, note ampersand
      [printUnattendedInvocation setArgument:&myTwo atIndex:3];
      fPrintTimer = [[NSTimer scheduledTimerWithTimeInterval:60*30 
         invocation:printUnattendedInvocation repeats:YES]retain];
// 60*30 is timer repeat period, (seconds/minute)*minutes
   }
}

Conclusion

We have resolved many of the single page report printing issues. For example, we have answered how to collect views for printing making subviews both in IB and programmatically. We have show how to relocate and resize views in a clean way for printing including the ability to exclude views from output. We have shown how to bypass the print panel specifying number of copies, orientation, paper name, scaling, and margins. Finally, we constructed a simple argument-passing timer that will run your print jobs at any specified time. For multi-page printing jobs there is always NSDocument.


If he had to do it all over again Clark would choose to be born one of the Sons of Liberty. The fact that the main Boston organizer was Ebenezer McIntosh and that many of the group were printers and publishers is not lost on him. He can be contacted at cjackson@cityoftacoma.org.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

Latest Forum Discussions

See All

Top Mobile Game Discounts
Every day, we pick out a curated list of the best mobile discounts on the App Store and post them here. This list won't be comprehensive, but it every game on it is recommended. Feel free to check out the coverage we did on them in the links... | Read more »
Price of Glory unleashes its 1.4 Alpha u...
As much as we all probably dislike Maths as a subject, we do have to hand it to geometry for giving us the good old Hexgrid, home of some of the best strategy games. One such example, Price of Glory, has dropped its 1.4 Alpha update, stocked full... | Read more »
The SLC 2025 kicks off this month to cro...
Ever since the Solo Leveling: Arise Championship 2025 was announced, I have been looking forward to it. The promotional clip they released a month or two back showed crowds going absolutely nuts for the previous competitions, so imagine the... | Read more »
Dive into some early Magicpunk fun as Cr...
Excellent news for fans of steampunk and magic; the Precursor Test for Magicpunk MMORPG Crystal of Atlan opens today. This rather fancy way of saying beta test will remain open until March 5th and is available for PC - boo - and Android devices -... | Read more »
Prepare to get your mind melted as Evang...
If you are a fan of sci-fi shooters and incredibly weird, mind-bending anime series, then you are in for a treat, as Goddess of Victory: Nikke is gearing up for its second collaboration with Evangelion. We were also treated to an upcoming... | Read more »
Square Enix gives with one hand and slap...
We have something of a mixed bag coming over from Square Enix HQ today. Two of their mobile games are revelling in life with new events keeping them alive, whilst another has been thrown onto the ever-growing discard pile Square is building. I... | Read more »
Let the world burn as you have some fest...
It is time to leave the world burning once again as you take a much-needed break from that whole “hero” lark and enjoy some celebrations in Genshin Impact. Version 5.4, Moonlight Amidst Dreams, will see you in Inazuma to attend the Mikawa Flower... | Read more »
Full Moon Over the Abyssal Sea lands on...
Aether Gazer has announced its latest major update, and it is one of the loveliest event names I have ever heard. Full Moon Over the Abyssal Sea is an amazing name, and it comes loaded with two side stories, a new S-grade Modifier, and some fancy... | Read more »
Open your own eatery for all the forest...
Very important question; when you read the title Zoo Restaurant, do you also immediately think of running a restaurant in which you cook Zoo animals as the course? I will just assume yes. Anyway, come June 23rd we will all be able to start up our... | Read more »
Crystal of Atlan opens registration for...
Nuverse was prominently featured in the last month for all the wrong reasons with the USA TikTok debacle, but now it is putting all that behind it and preparing for the Crystal of Atlan beta test. Taking place between February 18th and March 5th,... | Read more »

Price Scanner via MacPrices.net

AT&T is offering a 65% discount on the ne...
AT&T is offering the new iPhone 16e for up to 65% off their monthly finance fee with 36-months of service. No trade-in is required. Discount is applied via monthly bill credits over the 36 month... Read more
Use this code to get a free iPhone 13 at Visi...
For a limited time, use code SWEETDEAL to get a free 128GB iPhone 13 Visible, Verizon’s low-cost wireless cell service, Visible. Deal is valid when you purchase the Visible+ annual plan. Free... Read more
M4 Mac minis on sale for $50-$80 off MSRP at...
B&H Photo has M4 Mac minis in stock and on sale right now for $50 to $80 off Apple’s MSRP, each including free 1-2 day shipping to most US addresses: – M4 Mac mini (16GB/256GB): $549, $50 off... Read more
Buy an iPhone 16 at Boost Mobile and get one...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering one year of free Unlimited service with the purchase of any iPhone 16. Purchase the iPhone at standard MSRP, and then choose... Read more
Get an iPhone 15 for only $299 at Boost Mobil...
Boost Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering the 128GB iPhone 15 for $299.99 including service with their Unlimited Premium plan (50GB of premium data, $60/month), or $20... Read more
Unreal Mobile is offering $100 off any new iP...
Unreal Mobile, an MVNO using AT&T and T-Mobile’s networks, is offering a $100 discount on any new iPhone with service. This includes new iPhone 16 models as well as iPhone 15, 14, 13, and SE... Read more
Apple drops prices on clearance iPhone 14 mod...
With today’s introduction of the new iPhone 16e, Apple has discontinued the iPhone 14, 14 Pro, and SE. In response, Apple has dropped prices on unlocked, Certified Refurbished, iPhone 14 models to a... Read more
B&H has 16-inch M4 Max MacBook Pros on sa...
B&H Photo is offering a $360-$410 discount on new 16-inch MacBook Pros with M4 Max CPUs right now. B&H offers free 1-2 day shipping to most US addresses: – 16″ M4 Max MacBook Pro (36GB/1TB/... Read more
Amazon is offering a $100 discount on the M4...
Amazon has the M4 Pro Mac mini discounted $100 off MSRP right now. Shipping is free. Their price is the lowest currently available for this popular mini: – Mac mini M4 Pro (24GB/512GB): $1299, $100... Read more
B&H continues to offer $150-$220 discount...
B&H Photo has 14-inch M4 MacBook Pros on sale for $150-$220 off MSRP. B&H offers free 1-2 day shipping to most US addresses: – 14″ M4 MacBook Pro (16GB/512GB): $1449, $150 off MSRP – 14″ M4... Read more

Jobs Board

All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.