Printer

Overview

Since 3.0

The <ace:printer> tag sends a specific component to the printer, avoiding printing the full page. It must be inside <h:commandButton> or <h:commandLink>.

See the ICEfaces Showcase Live Demo of this component, complete with source code.

Getting Started

This is a typical usage example of the printer component.

<h:graphicImage id="image" value="#{bean.imagePath}" />

<h:commandLink>
    <h:outputText value="print image"/>
    <ace:printer for="image"/>
</h:commandLink>

Attributes

TagLib Documentation
For reference, the taglib documentation for this component is available here.

for Specifies the id of the component to print.

Client Behavior Events

action

Fired when the parent component is clicked or activated via the keyboard (default event).

Prior to 4.0 this event was named "activate". The "activate" event name is now deprecated but treated as an alias for "action" for backwards compatibility with existing applications.

JavaScript APIs / Client Behaviours

ICEfaces 3.x

The client side component object is exposed through the global variable name specified in the widgetVar attribute.

ICEfaces 4+

The "widgetVar" attribute on the ACE components has been removed in ICEfaces 4 and in its place a new "ice.ace.instance()" client JavaScript object lookup API has been introduced. The reason for this change is to enable lazy-initialization of the ACE component JavaScript objects to improve runtime performance and reduce browser memory use.

var widget = ice.ace.instance('frm:componentId);

The ice.ace.instance function requires the full client id of the component to be specified, such as "j_idt77:componentId" instead of just "componentId". To reduce the complexity of working with complete IDs with this function it may be preferable in some cases to use prependId="false" in the enclosing form (e.g. <h:form prependId="false">).

This component doesn't have a client-side API made specifically to be used by application developers. However, the component's internal methods and variables can be accessed in this way, including the underlying jQuery object and objects from underlying Javascript libraries (if applicable), and can be used for whatever purpose a developer might have in mind.

Javascript callbacks can be supplied in the onStart, onError, onSuccess, and onComplete attributes of the <ace:ajax /> tag for the action event. The onStart callback must explicitly return true if the ajax event is to continue.

Keyboard and ARIA support

There is no specific keyboard or ARIA support for this component.

CSS Classes

This component uses no CSS classes.

Known Issues

On Firefox browsers, some large objects on the page might be cut off and not printed to a second page, if they span more than one page. This is a known issue with the Firefox browser itself with elements that are displayed inline (e.g. display:inline; or display:inline-block; ). To avoid this issue, simply make sure the component or HTML element that you want to print has display:block; in its style attribute.

Other Resources

None.