org.diamondspin
Class DSWebFrame

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JInternalFrame
                  org.diamondspin.DSFrame
                      org.diamondspin.DSWebFrame

All Implemented Interfaces:

KeyListener, MouseListener, MouseMotionListener, ImageObserver, MenuContainer, Serializable, Cloneable, EventListener, Accessible, RootPaneContainer, WindowConstants, DSElement

public class DSWebFrame
extends DSFrame
implements MouseListener, MouseMotionListener, Cloneable, KeyListener, DSElement

Another kind of default element to display HTML, RTF or text document.

Copyright 2002-2009 DiamondSpin project. All Rights Reserved.

Permission to use, copy, modify and distribute this software and its documentation for educational, research and non-profit purposes, without fee, and without a written agreement is hereby granted, provided that the above copyright notice and the following three paragraphs appear in all copies.

To request Permission to incorporate this software into commercial products contact one of the authors of the project.

• Frederic Vernier (frederic.vernier@limsi.fr)
• Chia Shen (chia_shen@harvard.edu)
• Guillaume Besacier (guillaume.besacier@limsi.fr)
• Daniel Wigdor (dwigdor@microsoft.com)

IN NO EVENT SHALL THE AUTHORS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE AUTHORS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

THE AUTHORS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE AUTHORS HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Creation date : 13 november 2002

Version:

: 1.0

Author:

: Frederic vernier, (frederic.vernier@gmail.com) under Chia Shen supervision (chia_shen@harvard.edu).

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.diamondspin.DSFrame

DSFrame.DSInternalFrameTitlePane, DSFrame.DSMenuBarProxy, DSFrame.FingerRotationMode, DSFrame.FingerRotationSpeed

Nested classes/interfaces inherited from class javax.swing.JInternalFrame

JInternalFrame.AccessibleJInternalFrame, JInternalFrame.JDesktopIcon

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

protected String	Document1
protected DSEditorPane	DSEditorPane1
protected DSJComboBox	DSJComboBox1
protected DSKeyboardPanel	DSKeyboardPanel1
protected JPanel	JPanel1
protected JScrollPane	jScrollPane1

Fields inherited from class org.diamondspin.DSFrame

absoluteScale, absoluteShiftAngle, active, alpha, ALWAYS, annotatable, ANNOTATING, ANNOTATING_SINGLE_TIME, annotationOptions, backGlassPane, backPane, behavior, beta, betaAbsFlag, BETATED, biftpBottom, biftpTop, BLACK, BOTH, BOTTOM, CAST, center, CENTER, CENTERED, clickedComponent, clickedSlave, COLORBITS, corner_fold, corner_rotation, CORNER_SIZE, corners_resize_BR, corners_resize_TL, curvature, d, DARKER, diffAngle, DRAGGING, dsTabletopPane, dTopLeftCorner, ERASER, eraserIconPressed, ERASING, fingerRotatable, fingerRotationMode, fingerRotationSpeed, fixedPointForRotation, FOLDING, foldingManager, FOLLOWING_TWO_FINGERS, frontier, GLASS, globalPoint, grabCornerPoint, GRAY, idOwner, IN_BETWEEN, inertiaType, initDiagonal, inkIcon, inkIconPressed, INTELIGENT, invertiaCenter, invertiaMesh, jComboBox1, jViewport1, lastComponent, lastComponentUsed, lastRotationEvent, logoIcon, maximumScale, menubar, MIDDLE, minimumScale, mode, NONE, oldmenubar, OPPOSITE, previousMousePosition, previousPreviousMousePosition, RESIZING_BR, RESIZING_TL, rotatable, ROTATED, ROTATING, savedBeta, savedCenter, savedRotationCornerPosition, scale, scaleCorrection, serialVersionUID, shadow, shadowManager, shadowNeedRefresh, SHIFTED, slaveElementList, slavePosition, SMALL, thisDSFrame, titlebar, TOP, transparency, USER_COLOR, WAITING, zoomable, ZOOMING_BR, ZOOMING_TL

Fields inherited from class javax.swing.JInternalFrame

closable, CONTENT_PANE_PROPERTY, desktopIcon, FRAME_ICON_PROPERTY, frameIcon, GLASS_PANE_PROPERTY, iconable, IS_CLOSED_PROPERTY, IS_ICON_PROPERTY, IS_MAXIMUM_PROPERTY, IS_SELECTED_PROPERTY, isClosed, isIcon, isMaximum, isSelected, LAYERED_PANE_PROPERTY, maximizable, MENU_BAR_PROPERTY, resizable, ROOT_PANE_PROPERTY, rootPane, rootPaneCheckingEnabled, title, TITLE_PROPERTY

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 org.diamondspin.DSElement

HIGH_QUALITY, LOW_QUALITY

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

DSWebFrame(DSTabletopPane dsTabletopPane_Arg)
Constructor for use by DrawPane

DSWebFrame(DSTabletopPane dsTabletopPane_Arg, String Document_Arg, double d, double alpha, double scale)
Constructor

Method Summary

void	adjustSelection(int x, int y) Description of the Method
void	cancelSelection() Description of the Method
void	closeKeyboard() Closes the keyboard panel
URL	getActiveURL() Gets the activeURL attribute of the DSWebFrame object
String	getHTMLTitle()
String	getPreviewDocument() Gets the previewDocument attribute of the DSWebFrame object
String	getSelectedText() Gets the selectedText attribute of the DSWebFrame object
URL	getURL()
String	getWebFrameName()
void	initComponents() Init the swing component inside this window
boolean	isHtml() Gets the html attribute of the DSWebFrame object
void	keyPressed(KeyEvent KeyEvent_Arg) give the key event to the edited text if exist
void	keyReleased(KeyEvent KeyEvent_Arg) give the key event to the edited text if exist
void	keyTyped(KeyEvent KeyEvent_Arg) give the key event to the edited text if exist
void	makeSelection(int x, int y) Description of the Method
void	mouseReleased(MouseEvent MouseEvent_Arg) Description of the Method
void	openKeyboard() Opens the keyboard panel up
void	setURL(URL URL_Arg) change the url of the document
String	toString()

Methods inherited from class org.diamondspin.DSFrame

acceptSlave, acceptSlaveRelease, acceptSlavery, acceptSlaveryRelease, addDSElementListener, addDSElementPreListener, addFooterButton, addHeaderButton, addSlaveElement, addSlaveElement, askRefreshShadow, computeShadowPosition, contains, containsBack, containsFront, createImage, disableSnaping, doesContain, doesContainBack, doesContainFront, fireDSElementCenterChangedEvent, fireDSelementContentRepainted, fireDSElementDemotedEvent, fireDSElementDroppedEvent, fireDSElementFoldedEvent, fireDSElementGrabbingEvent, fireDSElementMovedEvent, fireDSElementPreCenterChangedEvent, fireDSElementPreFoldedEvent, fireDSElementPreMovedEvent, fireDSElementPreResizedEvent, fireDSElementPreRotatedEvent, fireDSElementPreZoomedEvent, fireDSElementResizedEvent, fireDSElementRotatedEvent, fireDSElementZoomedEvent, foldTo, getAbsoluteScale, getAlpha, getBackClippingShape, getBackGlassPane, getBackImage, getBackOpacity, getBackPane, getBackPaneHeight, getBackPaneWidth, getBackTransform, getBehavior, getBeta, getBounds, getBounds, getCenter, getD, getDSElementListener, getDSElementPreListener, getDSTabletopPane, getFingerRotationMode, getFingerRotationSpeed, getFoldPoint, getFoldPoint1, getFoldPoint2, getFoldProportion, getFoldShapeBack, getFoldShapeFront, getFoldType, getFrontClippingShape, getFrontier, getFrontImage, getFrontOpacity, getGlobalClippingShape, getGraphics, getIDOwner, getInertiaType, getJMenuBar, getJMenuBarPosition, getLocationOnScreen, getMaximumScale, getMinimumScale, getMinimumSize, getMode, getParent, getScale, getShadow, getShadowAdditionnalAngle, getShadowClip, getShadowDistance, getShadowImage, getShadowPosition, getShadowSize, getSlaveElementList, getSlavePosition, getSlaveTransform, getSnapAngle, getTabletopPane, getTitleBarPosition, getTransform, getTransparency, getViewPort, grabElement, inertiaCenter, inertiaMesh, inversePoint, inversePoint, inversePointBack, inverseVector, inverseVectorBack, isActive, isADragObject, isAnnotatable, isBetaAbs, isClip, isCornerFold, isCornerRotation, isCorners, isCornersResizeBR, isCornersResizeTL, isFingerRotatable, isFoldable, isFolded, isFoldReverse, isMouseTarget, isMyDragObject, isRotatable, isShadowHighQuality, isShadowSource, isShowing, isZoomable, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mousePressedInside, mousePressedInsideBack, mousePressedTestBack, mousePressedTestFront, moveCenter, moveCenter, moveElementCenterTo, paint, paint, paintBackInternal, paintFoldCorner, paintInternal, paintMenu2, paintResizeCornerBR, paintResizeCornerTL, paintRotateCorner, paintShadow, paintShadowOld, paintSlaves, paintSoftBorder, redispatchEvent, refreshShadow, removeAllSlaveElement, removeDSElementListener, removeDSElementPreListener, removeSlaveElement, repaint, resetSlaveFrame, reshape, setAbsoluteScale, setActive, setAllCorners, setAlpha, setAlphaAndD, setAnnotable, setAnnotatable, setAnnotationOptions, setBackClippingShape, setBackGlassPane, setBackOpacity, setBackPane, setBehavior, setBeta, setBeta, setBetaAbs, setCenter, setCenterTo, setCenterTo, setCornerFold, setCornerRotation, setCornersResizeBR, setCornersResizeTL, setD, setFingerRotatable, setFingerRotationMode, setFingerRotationSpeed, setFoldable, setFoldReverse, setFrontClippingShape, setFrontier, setFrontOpacity, setGlobalClippingShape, setIcon, setIDOwner, setInertiaType, setJMenuBar, setJMenuBarPosition, setMaximumScale, setMinimumScale, setMode, setPreferredSize, setRotatable, setRotationCorner, setScale, setShadow, setShadowAdditionnalAngle, setShadowClip, setShadowDistance, setShadowHighQuality, setShadowSource, setSize, setSize, setSlavePosition, setSlaveTransform, setSnapAngle, setTitleBarPosition, setTransparency, setViewPort, setZoomable, startAnnotating, transformBackToLocal, transformPoint, transformPoint, transformVector, unfold, validate

Methods inherited from class javax.swing.JInternalFrame

addImpl, addInternalFrameListener, createRootPane, dispose, doDefaultCloseAction, fireInternalFrameEvent, getAccessibleContext, getContentPane, getDefaultCloseOperation, getDesktopIcon, getDesktopPane, getFocusCycleRootAncestor, getFocusOwner, getFrameIcon, getGlassPane, getInternalFrameListeners, getLastCursor, getLayer, getLayeredPane, getMenuBar, getMostRecentFocusOwner, getNormalBounds, getRootPane, getTitle, getUI, getUIClassID, getWarningString, hide, isClosable, isClosed, isFocusCycleRoot, isIcon, isIconifiable, isMaximizable, isMaximum, isResizable, isRootPaneCheckingEnabled, isSelected, moveToBack, moveToFront, pack, paintComponent, paramString, remove, removeInternalFrameListener, restoreSubcomponentFocus, setClosable, setClosed, setContentPane, setCursor, setDefaultCloseOperation, setDesktopIcon, setFocusCycleRoot, setFrameIcon, setGlassPane, setIconifiable, setLayer, setLayer, setLayeredPane, setLayout, setMaximizable, setMaximum, setMenuBar, setNormalBounds, setResizable, setRootPane, setRootPaneCheckingEnabled, setSelected, setTitle, setUI, show, toBack, toFront, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, 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, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, 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, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, transferFocusBackward, transferFocusDownCycle, 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, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, show, size, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.event.MouseListener

mouseClicked, mouseEntered, mouseExited, mousePressed

Methods inherited from interface java.awt.event.MouseMotionListener

mouseDragged, mouseMoved

Methods inherited from interface org.diamondspin.DSElement

acceptSlavery, acceptSlaveryRelease, addDSElementListener, doesContain, getAbsoluteScale, getAlpha, getBeta, getD, getHeight, getIDOwner, getScale, getTransform, getWidth, grabElement, isActive, isBetaAbs, isMouseTarget, isVisible, mouseClicked, mouseDragged, mouseMoved, mousePressed, moveElementCenterTo, paint, paint, removeDSElementListener, setActive, setAlpha, setBeta, setBetaAbs, setD, setIDOwner, setScale, setSize, setVisible

Field Detail

DSEditorPane1

protected DSEditorPane DSEditorPane1

jScrollPane1

protected JScrollPane jScrollPane1

JPanel1

protected JPanel JPanel1

DSJComboBox1

protected DSJComboBox DSJComboBox1

DSKeyboardPanel1

protected DSKeyboardPanel DSKeyboardPanel1

Document1

protected String Document1

Constructor Detail

DSWebFrame

public DSWebFrame(DSTabletopPane dsTabletopPane_Arg)

Constructor for use by DrawPane

Parameters:

dsTabletopPane_Arg - The unique DSTabletopPane which display everything

DSWebFrame

public DSWebFrame(DSTabletopPane dsTabletopPane_Arg,
                  String Document_Arg,
                  double d,
                  double alpha,
                  double scale)

Constructor

Parameters:

dsTabletopPane_Arg - The unique DSTabletopPane which display everything

Document_Arg - The document name (file or url)

d - The distance to the center where to put the new element

alpha - The angle around the center where to put the new element

scale - The scale factor to zoom the elenemt

Method Detail

isHtml

public boolean isHtml()

Gets the html attribute of the DSWebFrame object

Returns:

The html value

getActiveURL

public URL getActiveURL()

Gets the activeURL attribute of the DSWebFrame object

Returns:

The activeURL value

getPreviewDocument

public String getPreviewDocument()

Gets the previewDocument attribute of the DSWebFrame object

Returns:

The previewDocument value

setURL

public void setURL(URL URL_Arg)

change the url of the document

Parameters:

URL_Arg - The new uRL value

getURL

public URL getURL()

Returns:

the url of the document

getWebFrameName

public String getWebFrameName()

Returns:

the name of the document used to create this element

toString

public String toString()

Description copied from class: DSFrame

Overrides:

toString in class DSFrame

Returns:

a string representation of this object

getHTMLTitle

public final String getHTMLTitle()

Returns:

a the title of the web page

initComponents

public final void initComponents()
                          throws Exception

Init the swing component inside this window

Throws:

Exception - Description of the Exception

mouseReleased

public void mouseReleased(MouseEvent MouseEvent_Arg)

Description of the Method

Specified by:

mouseReleased in interface MouseListener

Specified by:

mouseReleased in interface DSElement

Overrides:

mouseReleased in class DSFrame

Parameters:

MouseEvent_Arg - Description of the Parameter

keyTyped

public void keyTyped(KeyEvent KeyEvent_Arg)

give the key event to the edited text if exist

Specified by:

keyTyped in interface KeyListener

keyPressed

public void keyPressed(KeyEvent KeyEvent_Arg)

give the key event to the edited text if exist

Specified by:

keyPressed in interface KeyListener

keyReleased

public void keyReleased(KeyEvent KeyEvent_Arg)

give the key event to the edited text if exist

Specified by:

keyReleased in interface KeyListener

makeSelection

public void makeSelection(int x,
                          int y)

Description of the Method

Parameters:

x - Description of the Parameter

y - Description of the Parameter

adjustSelection

public void adjustSelection(int x,
                            int y)

Description of the Method

Parameters:

x - Description of the Parameter

y - Description of the Parameter

getSelectedText

public String getSelectedText()

Gets the selectedText attribute of the DSWebFrame object

Returns:

The selectedText value

cancelSelection

public void cancelSelection()

Description of the Method

openKeyboard

public void openKeyboard()

Opens the keyboard panel up

closeKeyboard

public void closeKeyboard()

Closes the keyboard panel