org.openide.awt
Class HtmlBrowser.BrowserComponent

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--org.openide.windows.TopComponent
                          |
                          +--org.openide.windows.CloneableTopComponent
                                |
                                +--org.openide.awt.HtmlBrowser.BrowserComponent

All Implemented Interfaces:

Accessible, Externalizable, ImageObserver, MenuContainer, Serializable, TopComponent.Cloneable

Enclosing class:

HtmlBrowser

public static class HtmlBrowser.BrowserComponent

extends CloneableTopComponent

See Also:

Serialized Form

Inner classes inherited from class org.openide.windows.CloneableTopComponent

CloneableTopComponent.Ref

Inner classes inherited from class org.openide.windows.TopComponent

TopComponent.Cloneable, TopComponent.NodeName, TopComponent.Registry

Inner classes inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Inner classes inherited from class java.awt.Container

Container.AccessibleAWTContainer

Inner classes inherited from class java.awt.Component

Component.AccessibleAWTComponent

Field Summary

static String

MODE_NAME programmatic name of special mode for this top component

Fields inherited from class org.openide.windows.CloneableTopComponent

EMPTY

Fields inherited from class org.openide.windows.TopComponent

CLOSE_EACH, CLOSE_LAST

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

HtmlBrowser.BrowserComponent()
Creates new html browser with toolbar and status line.

HtmlBrowser.BrowserComponent(boolean toolbar, boolean statusLine)
Creates new html browser with toolbar and status line.

HtmlBrowser.BrowserComponent(HtmlBrowser.Factory fact, boolean toolbar, boolean statusLine)
Creates new html browser.

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l) Adds property change listener.
protected void	componentActivated() Called when this component is activated.
protected CloneableTopComponent	createClonedObject() Called from Object.clone() to actually create a new component from this one.
URL	getDocumentURL() Gets current document url.
HelpCtx	getHelpCtx() Get the help context for this component.
Image	getIcon()
boolean	isStatusLineVisible() Gets status line state.
boolean	isToolbarVisible() Gets status toolbar.
void	open(Workspace workspace) always open this top component in our special mode, if no mode for this component is specified yet
void	readExternal(ObjectInput in) Deserialize this top component.
void	removePropertyChangeListener(PropertyChangeListener l) Removes property change listener.
void	setEnableHome(boolean b) Enables/disables Home button.
void	setEnableLocation(boolean b) Enables/disables location.
void	setStatusLineVisible(boolean v) Shows/hides status line.
void	setToolbarVisible(boolean v) Shows/hides toolbar.
void	setURL(String str) Sets new URL.
void	setURL(URL url) Sets new URL.
protected Object	writeReplace() Serializes browser component -> writes Replacer object which holds browser content and look.

Methods inherited from class org.openide.windows.CloneableTopComponent

canClose, clone, cloneComponent, cloneTopComponent, closeLast, getReference, setReference, writeExternal

Methods inherited from class org.openide.windows.TopComponent

close, close, closeNotify, componentDeactivated, getAccessibleContext, getActivatedNodes, getCloseOperation, getRegistry, getSystemActions, getUndoRedo, isOpened, isOpened, open, openNotify, requestFocus, requestVisible, setActivatedNodes, setCloseOperation, setIcon, setName

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Field Detail

MODE_NAME

public static final String MODE_NAME

programmatic name of special mode for this top component

Constructor Detail

HtmlBrowser.BrowserComponent

public HtmlBrowser.BrowserComponent()

Creates new html browser with toolbar and status line.

HtmlBrowser.BrowserComponent

public HtmlBrowser.BrowserComponent(boolean toolbar,
                                    boolean statusLine)

Creates new html browser with toolbar and status line.

HtmlBrowser.BrowserComponent

public HtmlBrowser.BrowserComponent(HtmlBrowser.Factory fact,
                                    boolean toolbar,
                                    boolean statusLine)

Creates new html browser.

Method Detail

open

public void open(Workspace workspace)

always open this top component in our special mode, if no mode for this component is specified yet

Overrides:

open in class TopComponent

Following copied from class: org.openide.windows.TopComponent

Parameters:

workspace - Workspace on which component should be opened. Parameter can be null -> means current workspace.

See Also:

TopComponent.requestFocus()

writeReplace

protected Object writeReplace()
                       throws ObjectStreamException

Serializes browser component -> writes Replacer object which holds browser content and look.

Overrides:

writeReplace in class TopComponent

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Description copied from class: TopComponent

Deserialize this top component. Subclasses wishing to store state must call the super method, then read from the stream.

Overrides:

readExternal in class CloneableTopComponent

Following copied from class: org.openide.windows.TopComponent

Parameters:

in - the stream to deserialize from

createClonedObject

protected CloneableTopComponent createClonedObject()

Description copied from class: CloneableTopComponent

Called from CloneableTopComponent.clone() to actually create a new component from this one. The default implementation only clones the object by calling Object.clone(). Subclasses may leave this as is, assuming they have no special needs for the cloned data besides copying it from one object to the other. If they do, the superclass method should be called, and the returned object modified appropriately.

Overrides:

createClonedObject in class CloneableTopComponent

Following copied from class: org.openide.windows.CloneableTopComponent

Returns:

a copy of this object

getHelpCtx

public HelpCtx getHelpCtx()

Description copied from class: TopComponent

Get the help context for this component. Subclasses should generally override this to return specific help.

Overrides:

getHelpCtx in class TopComponent

Following copied from class: org.openide.windows.TopComponent

Returns:

the help context

componentActivated

protected void componentActivated()

Description copied from class: TopComponent

Called when this component is activated. This happens when the parent window of this component gets focus (and this component is the preferred one in it), or when this component is selected in its window (and its window was already focussed). Override this method to perform some special action on component activation: typically, set performers for relevant actions. Remember to call the super method. The default implementation does nothing.

Overrides:

componentActivated in class TopComponent

getIcon

public Image getIcon()

Overrides:

getIcon in class TopComponent

Following copied from class: org.openide.windows.TopComponent

Returns:

The icon of the top component

setURL

public void setURL(String str)

Sets new URL.

Parameters:

str - URL to show in this browser.

setURL

public void setURL(URL url)

Sets new URL.

Parameters:

str - URL to show in this browser.

getDocumentURL

public final URL getDocumentURL()

Gets current document url.

setEnableHome

public final void setEnableHome(boolean b)

Enables/disables Home button.

setEnableLocation

public final void setEnableLocation(boolean b)

Enables/disables location.

isStatusLineVisible

public boolean isStatusLineVisible()

Gets status line state.

setStatusLineVisible

public void setStatusLineVisible(boolean v)

Shows/hides status line.

isToolbarVisible

public boolean isToolbarVisible()

Gets status toolbar.

setToolbarVisible

public void setToolbarVisible(boolean v)

Shows/hides toolbar.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Adds property change listener.

Overrides:

addPropertyChangeListener in class JComponent

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

Removes property change listener.

Overrides:

removePropertyChangeListener in class JComponent