echopoint
Class PrintRequest

java.lang.Object
  nextapp.echo.AbstractComponent
      echopoint.PrintRequest

All Implemented Interfaces:

java.io.Serializable, Component

public class PrintRequest
extends AbstractComponent

The PrintRequest component can be used to get the client browser to print the current window or frame.

The presence of this no visual component will cause the browser to show the platform print dialog and allow them to print the current contents of the page.

The component will only perform printing if is active. Once it has been rendered once, it automatically sets itself to be non active. The allows it to be present as a component, without unintentional print requests.

See Also:

Serialized Form

Field Summary

Fields inherited from interface nextapp.echo.Component

BACKGROUND_CHANGED_PROPERTY, CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FONT_CHANGED_PROPERTY, FOREGROUND_CHANGED_PROPERTY, IDENTIFIER_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, MODEL_CHANGED_PROPERTY, SELECTABLE_CHANGED_PROPERTY, STYLE_BACKGROUND, STYLE_FONT, STYLE_FOREGROUND, UPDATE_PROPERTY, VISIBLE_CHANGED_PROPERTY

Constructor Summary

PrintRequest()
Contructs a PrintRequest that is active and only prints the current frame.

PrintRequest(boolean active)
Contructs a PrintRequest only prints the current frame will be active if active is set to true.

Method Summary

boolean	isActive()
boolean	isFrameOnly()
void	setActive(boolean active)
void	setFrameOnly(boolean frameOnly)

Methods inherited from class nextapp.echo.AbstractComponent

add, add, addHierarchyListener, addPropertyChangeListener, applyStyle, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getClientId, getComponent, getComponentCount, getComponents, getEchoInstance, getFont, getForeground, getIdentifier, getListenerList, getLocale, getParent, indexOf, init, isAncestorOf, isDifferent, isEnabled, isFocused, isRecursivelyVisible, isRegistered, isSelectableForScriptRecorder, isShowing, isVisible, processHierarchyEvent, remove, remove, removeAll, removeHierarchyListener, removePropertyChangeListener, setBackground, setClientId, setEnabled, setFocused, setFont, setForeground, setIdentifier, setLocale, setParent, setRegistered, setSelectableForScriptRecorder, setVisible, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrintRequest

public PrintRequest()

Contructs a PrintRequest that is active and only prints the current frame.

PrintRequest

public PrintRequest(boolean active)

Contructs a PrintRequest only prints the current frame will be active if active is set to true.

Method Detail

isActive

public boolean isActive()

Returns:

true if the PrintRequest is active

setActive

public void setActive(boolean active)

Parameters:

active - - true if the Printrequest is to be active

isFrameOnly

public boolean isFrameOnly()

Returns:

true if the frame only will be printed

setFrameOnly

public void setFrameOnly(boolean frameOnly)

Parameters:

frameOnly - set to true if the only the frame is to be printed