Package nl.nikhef.jgridstart.gui.util

Class TemplateButtonPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

nl.nikhef.jgridstart.gui.util.TemplateButtonPanel

All Implemented Interfaces:

ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, IDocumentContainer, ITemplateContainer, ITemplatePanel, IXHTMLPanel, org.xhtmlrenderer.extend.UserInterface, org.xhtmlrenderer.simple.extend.FormSubmissionListener

public class TemplateButtonPanel
extends JPanel
implements ITemplatePanel

A TemplatePanel in a scrolled window with buttons below.

This is a thin layer over TemplatePanel that adds optional buttons below the document view. It may be viewed as a kind of JOptionPane with a TemplatePanel as dialog contents, but the buttons here are to be supplied explicitely. TemplateWizard is an example that adds previous/next buttons.

Additionally, links are opened in an external web browser using URLLauncher.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

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

JComponent.AccessibleJComponent

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

JPanel.AccessibleJPanel

Field Summary

Fields

Modifier and Type	Field	Description
protected int	btnBorderWidth	empty space around buttons
protected JPanel	buttonpane	pane containing the buttons
protected TemplatePanel	contentpane	the actual html template pane

Fields inherited from class java.awt.Component

accessibleContext, 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

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Constructor Summary

Constructors

Constructor	Description
TemplateButtonPanel()
TemplateButtonPanel(String src)

Method Summary

Modifier and Type	Method	Description
void	addButton(JButton btn, boolean isDefault)	adds an action to the button list
void	addButton(JButton btn, boolean isDefault, boolean isLast)	adds an action to the button list
void	addButton(JPanel panel, JButton btn, boolean isDefault)	adds an action to the button list
void	addButton(JPanel panel, JButton btn, boolean isDefault, boolean isLast)	adds an action to the button list
void	addMouseTrackingListener(org.xhtmlrenderer.swing.FSMouseListener l)
void	addSeparator()	adds a seperator to the button list
void	componentHidden(ComponentEvent e)
void	componentMoved(ComponentEvent e)
void	componentResized(ComponentEvent e)
void	componentShown(ComponentEvent e)
Properties	data()	Return the properties.
JPanel	getButtonPane()	returns the bottom JPanel that can contain the buttons.
Document	getDocument()
String	getDocumentTitle()	Returns the title as reported by the NamespaceHandler assigned to the SharedContext in this panel.
Component	getFormComponent(String name)	Return the Swing/AWT component for a form element by name.
Map<String,Component>	getFormComponents()	Return the list of Swing/AWT components.
List<?>	getMouseTrackingListeners()
org.xhtmlrenderer.layout.SharedContext	getSharedContext()
URL	getURL()
boolean	isActive(Element e)
boolean	isFocus(Element e)
boolean	isHover(Element e)
boolean	print()	print the contents of this pane.
boolean	refresh()	Refresh the contents so that all parsing is redone.
void	reloadDocument(String URI)	Reloads the document using the same base URL and namespace handler.
void	reloadDocument(Document doc)	Reloads the document using the same base URL and namespace handler.
void	removeMouseTrackingListener(org.xhtmlrenderer.swing.FSMouseListener l)
void	replaceLinkListener(org.xhtmlrenderer.swing.LinkListener llnew)	Replace the listener that is activated when a link is clicked.
void	setData(Properties p)	Set the properties to use for the template and form elements.
void	setDocument(File file)	Renders a Document read from an InputStream using a URL as a base URL for relative paths.
void	setDocument(InputStream stream, String url)	Renders a Document read from an InputStream using a URL as a base URL for relative paths.
void	setDocument(InputStream stream, String url, org.xhtmlrenderer.extend.NamespaceHandler nsh)
void	setDocument(String uri)	Loads and renders a Document given a uri.
void	setDocument(String url, org.xhtmlrenderer.extend.NamespaceHandler nsh)
void	setDocument(TemplateDocument doc)	Renders an ITemplateDocument instance.
void	setDocument(TemplateDocument doc, org.xhtmlrenderer.extend.NamespaceHandler nsh)
void	setDocument(Document doc)	Renders an XML Document instance.
void	setDocument(Document doc, String url)	Renders a Document using a URL as a base URL for relative paths.
void	setDocumentFromString(String content, String url, org.xhtmlrenderer.extend.NamespaceHandler nsh)
void	setFormSubmissionListener(org.xhtmlrenderer.simple.extend.FormSubmissionListener fsl)
void	setSharedContext(org.xhtmlrenderer.layout.SharedContext ctx)	Sets the RenderingContext attribute of the XHTMLPanel object.
void	setSubmitAction(Action e)	Set the action to perform on form submission.
void	submit(String query)

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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, 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, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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 javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class java.lang.Object

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

Field Detail

contentpane

protected TemplatePanel contentpane

the actual html template pane

buttonpane

protected JPanel buttonpane

pane containing the buttons

btnBorderWidth

protected final int btnBorderWidth

empty space around buttons

See Also:

Constant Field Values

Constructor Detail

TemplateButtonPanel

public TemplateButtonPanel()

TemplateButtonPanel

public TemplateButtonPanel(String src)
                    throws IOException

Throws:

IOException

Method Detail

getButtonPane

public JPanel getButtonPane()

returns the bottom JPanel that can contain the buttons.

By default, horizontal glue is added as the first element, so that when you use Container.add(java.awt.Component), elements are right-aligned. If you really want to have this differently, call Container.removeAll() on the returned JPanel after construction of this TemplateButtonPanel.

addButton

public void addButton(JPanel panel,
                      JButton btn,
                      boolean isDefault,
                      boolean isLast)

adds an action to the button list

Parameters:

panel - Panel to add the button to; useful when creating sub-panels

btn - Button to add

isDefault - true whether this is the default action (set on only one)

isLast - whether this is the final button to add, for refreshing

addButton

public void addButton(JPanel panel,
                      JButton btn,
                      boolean isDefault)

adds an action to the button list

Parameters:

panel - Panel to add the button to; useful when creating sub-panels

btn - Button to add

isDefault - true whether this is the default action (set on only one)

addButton

public void addButton(JButton btn,
                      boolean isDefault,
                      boolean isLast)

adds an action to the button list

The button needs to have an Action specified at this moment.

Parameters:

btn - Button to add

isDefault - true whether this is the default action (set on only one)

isLast - whether this is the final button to add, for refreshing

addButton

public void addButton(JButton btn,
                      boolean isDefault)

adds an action to the button list

The button needs to have an Action specified at this moment.

Parameters:

btn - Button to add

isDefault - true whether this is the default action (set on only one)

addSeparator

public void addSeparator()

adds a seperator to the button list

This is implemented as some whitespace to visually separate buttons

addMouseTrackingListener

public void addMouseTrackingListener(org.xhtmlrenderer.swing.FSMouseListener l)

Specified by:

addMouseTrackingListener in interface IXHTMLPanel

componentHidden

public void componentHidden(ComponentEvent e)

Specified by:

componentHidden in interface ComponentListener

componentMoved

public void componentMoved(ComponentEvent e)

Specified by:

componentMoved in interface ComponentListener

componentResized

public void componentResized(ComponentEvent e)

Specified by:

componentResized in interface ComponentListener

componentShown

public void componentShown(ComponentEvent e)

Specified by:

componentShown in interface ComponentListener

data

public Properties data()

Description copied from interface: ITemplateContainer

Return the properties.

Use this to retrieve data from form elements. The name of each element has a corresponding property key, and the value of the property is updated when the form element changes.

Specified by:

data in interface ITemplateContainer

getDocument

public Document getDocument()

Specified by:

getDocument in interface IDocumentContainer

getDocumentTitle

public String getDocumentTitle()

Description copied from interface: IDocumentContainer

Returns the title as reported by the NamespaceHandler assigned to the SharedContext in this panel. For an HTML document, this will be the contents of /html/head/title.

Specified by:

getDocumentTitle in interface IDocumentContainer

Returns:

the document title, or "" if the namespace handler cannot find a title, or if there is no current document in the panel.

getMouseTrackingListeners

public List<?> getMouseTrackingListeners()

Specified by:

getMouseTrackingListeners in interface IXHTMLPanel

getSharedContext

public org.xhtmlrenderer.layout.SharedContext getSharedContext()

Specified by:

getSharedContext in interface IXHTMLPanel

getURL

public URL getURL()

Specified by:

getURL in interface IDocumentContainer

isActive

public boolean isActive(Element e)

Specified by:

isActive in interface org.xhtmlrenderer.extend.UserInterface

isFocus

public boolean isFocus(Element e)

Specified by:

isFocus in interface org.xhtmlrenderer.extend.UserInterface

isHover

public boolean isHover(Element e)

Specified by:

isHover in interface org.xhtmlrenderer.extend.UserInterface

print

public boolean print()
              throws PrinterException

Description copied from interface: IXHTMLPanel

print the contents of this pane.

A print dialog is shown first.

Specified by:

print in interface IXHTMLPanel

Throws:

PrinterException

refresh

public boolean refresh()

Description copied from interface: ITemplateContainer

Refresh the contents so that all parsing is redone.

Note that the template may or may not be retrieved again from its source.

This happens automatically in ITemplateContainer.setData(java.util.Properties) and ITemplateContainer.setDocument(nl.nikhef.xhtmlrenderer.swing.TemplateDocument).

Specified by:

refresh in interface ITemplateContainer

Returns:

true on success, false if no document URI is available

reloadDocument

public void reloadDocument(Document doc)

Description copied from interface: IDocumentContainer

Reloads the document using the same base URL and namespace handler. Reloading will pick up changes to styles within the document.

Specified by:

reloadDocument in interface IDocumentContainer

Parameters:

doc - The document to reload.

reloadDocument

public void reloadDocument(String URI)

Description copied from interface: IDocumentContainer

Reloads the document using the same base URL and namespace handler. Reloading will pick up changes to styles within the document.

Specified by:

reloadDocument in interface IDocumentContainer

Parameters:

URI - A URI for the Document to load, for example, file.toURL().toExternalForm().

removeMouseTrackingListener

public void removeMouseTrackingListener(org.xhtmlrenderer.swing.FSMouseListener l)

Specified by:

removeMouseTrackingListener in interface IXHTMLPanel

replaceLinkListener

public void replaceLinkListener(org.xhtmlrenderer.swing.LinkListener llnew)

Description copied from interface: IXHTMLPanel

Replace the listener that is activated when a link is clicked.

This is a convenience method that first removes all LinkListeners, and then adds the supplied one.

Specified by:

replaceLinkListener in interface IXHTMLPanel

Parameters:

llnew - New LinkListener to use for this panel

setData

public void setData(Properties p)

Description copied from interface: ITemplateContainer

Set the properties to use for the template and form elements.

Also reparses the document and updates the panel, if a template was set.

Specified by:

setData in interface ITemplateContainer

Parameters:

p - New properties to set

setDocument

public void setDocument(TemplateDocument doc)

Description copied from interface: ITemplateContainer

Renders an ITemplateDocument instance.

Specified by:

setDocument in interface ITemplateContainer

Parameters:

doc - template to show, this will be processed with the data supplied by this container.

setDocument

public void setDocument(TemplateDocument doc,
                        org.xhtmlrenderer.extend.NamespaceHandler nsh)

setDocument

public void setDocument(Document doc,
                        String url)

Description copied from interface: IDocumentContainer

Renders a Document using a URL as a base URL for relative paths.

Specified by:

setDocument in interface IDocumentContainer

Parameters:

doc - The new document value

url - The new document value

setDocument

public void setDocument(Document doc)

Description copied from interface: IDocumentContainer

Renders an XML Document instance. Make sure that no relative resources are needed

Specified by:

setDocument in interface IDocumentContainer

Parameters:

doc - The document to render.

setDocument

public void setDocument(File file)
                 throws Exception

Description copied from interface: IDocumentContainer

Renders a Document read from an InputStream using a URL as a base URL for relative paths.

Specified by:

setDocument in interface IDocumentContainer

Parameters:

file - The file to read the Document from. Relative paths will be resolved based on the file's parent directory.

Throws:

Exception

setDocument

public void setDocument(InputStream stream,
                        String url,
                        org.xhtmlrenderer.extend.NamespaceHandler nsh)

Specified by:

setDocument in interface IDocumentContainer

setDocument

public void setDocument(InputStream stream,
                        String url)
                 throws Exception

Description copied from interface: IDocumentContainer

Renders a Document read from an InputStream using a URL as a base URL for relative paths.

Specified by:

setDocument in interface IDocumentContainer

Parameters:

stream - The stream to read the Document from.

url - The URL used to resolve relative path references.

Throws:

Exception

setDocument

public void setDocument(String url,
                        org.xhtmlrenderer.extend.NamespaceHandler nsh)

Specified by:

setDocument in interface IDocumentContainer

setDocument

public void setDocument(String uri)

Description copied from interface: IDocumentContainer

Loads and renders a Document given a uri. The uri is resolved by the UserAgentCallback

Specified by:

setDocument in interface IDocumentContainer

setDocumentFromString

public void setDocumentFromString(String content,
                                  String url,
                                  org.xhtmlrenderer.extend.NamespaceHandler nsh)

Specified by:

setDocumentFromString in interface IDocumentContainer

setFormSubmissionListener

public void setFormSubmissionListener(org.xhtmlrenderer.simple.extend.FormSubmissionListener fsl)

Specified by:

setFormSubmissionListener in interface IXHTMLPanel

setSharedContext

public void setSharedContext(org.xhtmlrenderer.layout.SharedContext ctx)

Description copied from interface: IXHTMLPanel

Sets the RenderingContext attribute of the XHTMLPanel object. Generally you should not use this unless you have a heavily customized context to use. To modify just some rendering behavior, consider using IXHTMLPanel.getSharedContext() to retrieve the current context, and using mutators to change its behavior.

Specified by:

setSharedContext in interface IXHTMLPanel

Parameters:

ctx - A new RenderingContext to use for rendering.

setSubmitAction

public void setSubmitAction(Action e)

Description copied from interface: ITemplateContainer

Set the action to perform on form submission.

If this is set to null, the standard behaviour is done: posting data to the url supplied by the form.

Specified by:

setSubmitAction in interface ITemplateContainer

submit

public void submit(String query)

Specified by:

submit in interface org.xhtmlrenderer.simple.extend.FormSubmissionListener

getFormComponent

public Component getFormComponent(String name)

Description copied from interface: ITemplatePanel

Return the Swing/AWT component for a form element by name.

Note that multiple radio buttons have the same name, so for these the name is actually in the form name.value.

Specified by:

getFormComponent in interface ITemplatePanel

Parameters:

name - like myfield in >input type="text" name="myfield" /<

Returns:

The Swing/AWT component, or null if not found.

getFormComponents

public Map<String,Component> getFormComponents()

Description copied from interface: ITemplatePanel

Return the list of Swing/AWT components.

Specified by:

getFormComponents in interface ITemplatePanel

Returns:

Readonly map of Swing/AWT components, indexed by their name.

See Also:

ITemplatePanel.getFormComponent(java.lang.String)