Style Intelligence v12.0

inetsoft.sree.viewer
Class ViewerPane

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JLayeredPane
                  extended by javax.swing.JDesktopPane
                      extended by inetsoft.sree.viewer.ViewerPane
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, InternalFrameListener

public class ViewerPane
extends JDesktopPane
implements InternalFrameListener

Java replet viewer pane. This is the internal pane used in viewer. It can be used to embed a viewer in other windows. The application needs to implement all menus and buttons to operate on the viewer pane.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JDesktopPane
JDesktopPane.AccessibleJDesktopPane
 
Nested classes/interfaces inherited from class javax.swing.JLayeredPane
JLayeredPane.AccessibleJLayeredPane
 
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class javax.swing.JDesktopPane
LIVE_DRAG_MODE, OUTLINE_DRAG_MODE
 
Fields inherited from class javax.swing.JLayeredPane
DEFAULT_LAYER, DRAG_LAYER, FRAME_CONTENT_LAYER, LAYER_PROPERTY, MODAL_LAYER, PALETTE_LAYER, POPUP_LAYER
 
Fields inherited from class javax.swing.JComponent
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 
Fields inherited from class java.awt.Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ViewerPane(JLabel status)
          Create a ViewerPane.
 
Method Summary
 void addWindow(String title, ViewFrame win)
          Add a sub-window to the viewer mdi.
protected static RepletParameters checkParameters(RepletParameters params, RepletRequest request)
          Check if parameters already supplied in the request's session, and modify the parameter definition to remove any duplicate parameters.
 ViewFrame createViewFrame(String name, RepletRepository engine)
          Create a new ViewFrame.
 void dispose()
          Close the viewer window.
protected  void enqueue(ViewPreviewPane.ViewPane pane, int pn)
          Add a page retrieval request to the queue.
protected  void enqueueNow(ViewPreviewPane.ViewPane pane, int pn)
          Add a page retrieval request to the queue, and process it right now.
 ViewFrame getCurrentFrame()
          Get the current report frame instance.
 Principal getPrincipal()
          Get the principal bound to an entity.
 RepletRepository getRepletRepository()
          Get the repository server.
 void internalFrameActivated(InternalFrameEvent e)
           
 void internalFrameClosed(InternalFrameEvent e)
           
 void internalFrameClosing(InternalFrameEvent e)
           
 void internalFrameDeactivated(InternalFrameEvent e)
           
 void internalFrameDeiconified(InternalFrameEvent e)
           
 void internalFrameIconified(InternalFrameEvent e)
           
 void internalFrameOpened(InternalFrameEvent e)
           
 void setAppletContext(AppletContext applet)
          Set the applet context if this viewer is launched from an applet.
 void setPreferredFrameSize(Dimension pref)
          Set the preferred frame size.
 void setPrincipal(Principal principal)
          Set the principal to use for requests to the repository server.
 void setRepletRepository(RepletRepository engine)
          Set the repository server.
 void showMessage(String msg)
          Show a message in a message dialog.
 ViewFrame showReplet(Object id)
          Show a replet in a viewer window.
 ViewFrame showReplet(String name, RepletRequest req)
          Show a replet in a viewer window.
 ViewFrame showReplet(String name, RepletRequest req, ViewFrame frame)
          Show a replet in a viewer window using an existing frame.
 void showStatus(String msg)
          Show status on the status bar.
 void showURL(String url, String target)
          Show the document in a browser window.
 
Methods inherited from class javax.swing.JDesktopPane
addImpl, getAccessibleContext, getAllFrames, getAllFramesInLayer, getDesktopManager, getDragMode, getSelectedFrame, getUI, getUIClassID, paramString, remove, removeAll, selectFrame, setComponentZOrder, setDesktopManager, setDragMode, setSelectedFrame, setUI, updateUI
 
Methods inherited from class javax.swing.JLayeredPane
getComponentCountInLayer, getComponentsInLayer, getComponentToLayer, getIndexOf, getLayer, getLayer, getLayeredPaneAbove, getObjectForLayer, getPosition, highestLayer, insertIndexForLayer, isOptimizedDrawingEnabled, lowestLayer, moveToBack, moveToFront, paint, putLayer, setLayer, setLayer, setPosition
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeContainerListener, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ViewerPane

public ViewerPane(JLabel status)
Create a ViewerPane.

Parameters:
status - label for displaying the window status line.
Method Detail

createViewFrame

public ViewFrame createViewFrame(String name,
                                 RepletRepository engine)
Create a new ViewFrame.

Parameters:
name - name of the frame.
engine - repository server proxy.
Returns:
new ViewFrame window.

setPrincipal

public void setPrincipal(Principal principal)
Set the principal to use for requests to the repository server.


getPrincipal

public Principal getPrincipal()
Get the principal bound to an entity.


setAppletContext

public void setAppletContext(AppletContext applet)
Set the applet context if this viewer is launched from an applet.


setRepletRepository

public void setRepletRepository(RepletRepository engine)
Set the repository server.

Parameters:
engine - repository object (proxy).

getRepletRepository

public RepletRepository getRepletRepository()
Get the repository server.


getCurrentFrame

public ViewFrame getCurrentFrame()
Get the current report frame instance.


showReplet

public ViewFrame showReplet(String name,
                            RepletRequest req)
Show a replet in a viewer window.

Parameters:
name - replet name.
req - replet request.

showReplet

public ViewFrame showReplet(String name,
                            RepletRequest req,
                            ViewFrame frame)
Show a replet in a viewer window using an existing frame.

Parameters:
name - replet name.
req - replet request.

showReplet

public ViewFrame showReplet(Object id)
Show a replet in a viewer window.

Parameters:
id - replet ID. The replet must already be generated on server.

showURL

public void showURL(String url,
                    String target)
Show the document in a browser window.

Parameters:
url - URL string.
target - target frame.

dispose

public void dispose()
Close the viewer window.


showStatus

public void showStatus(String msg)
Show status on the status bar.


setPreferredFrameSize

public void setPreferredFrameSize(Dimension pref)
Set the preferred frame size. The default is 780x580.


showMessage

public void showMessage(String msg)
Show a message in a message dialog.


enqueue

protected void enqueue(ViewPreviewPane.ViewPane pane,
                       int pn)
Add a page retrieval request to the queue.


enqueueNow

protected void enqueueNow(ViewPreviewPane.ViewPane pane,
                          int pn)
Add a page retrieval request to the queue, and process it right now.


addWindow

public void addWindow(String title,
                      ViewFrame win)
Add a sub-window to the viewer mdi.


checkParameters

protected static RepletParameters checkParameters(RepletParameters params,
                                                  RepletRequest request)
Check if parameters already supplied in the request's session, and modify the parameter definition to remove any duplicate parameters.

Parameters:
params - the replet parameters.
request - the client request wrapper.
Returns:
the modified replet parameters.

internalFrameOpened

public void internalFrameOpened(InternalFrameEvent e)
Specified by:
internalFrameOpened in interface InternalFrameListener

internalFrameClosing

public void internalFrameClosing(InternalFrameEvent e)
Specified by:
internalFrameClosing in interface InternalFrameListener

internalFrameClosed

public void internalFrameClosed(InternalFrameEvent e)
Specified by:
internalFrameClosed in interface InternalFrameListener

internalFrameIconified

public void internalFrameIconified(InternalFrameEvent e)
Specified by:
internalFrameIconified in interface InternalFrameListener

internalFrameDeiconified

public void internalFrameDeiconified(InternalFrameEvent e)
Specified by:
internalFrameDeiconified in interface InternalFrameListener

internalFrameActivated

public void internalFrameActivated(InternalFrameEvent e)
Specified by:
internalFrameActivated in interface InternalFrameListener

internalFrameDeactivated

public void internalFrameDeactivated(InternalFrameEvent e)
Specified by:
internalFrameDeactivated in interface InternalFrameListener

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.