Package org.apache.xalan.client
Class XSLTProcessorApplet
java.lang.Object
java.awt.Component
java.awt.Container
java.awt.Panel
java.applet.Applet
org.apache.xalan.client.XSLTProcessorApplet
- All Implemented Interfaces:
ImageObserver
,MenuContainer
,Serializable
,Accessible
Provides applet host for the XSLT processor. To perform transformations on an HTML client:
- Use an <applet> tag to embed this applet in the HTML client.
- Use the DocumentURL and StyleURL PARAM tags or the
setDocumentURL(java.lang.String)
andsetStyleURL(java.lang.String)
methods to specify the XML source document and XSL stylesheet. - Call the
getHtmlText()
method (or one of the transformToHtml() methods) to perform the transformation and return the result as a String.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.awt.Component
Component.BaselineResizeBehavior
-
Field Summary
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
ConstructorsConstructorDescriptionThe XSLTProcessorApplet constructor takes no arguments. -
Method Summary
Modifier and TypeMethodDescriptionvoid
destroy()
Cleanup; called when applet is terminated and unloaded.Given a String containing markup, escape the markup so it can be displayed in the browser.void
The processor keeps a cache of the source and style trees, so call this method if they have changed or you want to do garbage collection.Get basic information about the appletAssuming the stylesheet URL and the input XML URL have been set, perform the transformation and return the result as a String.String[][]
Get descriptions of the applet parameters.Get the HTML result Tree as a text string suitable for display in a browser.Get the XML source Tree as a text string suitable for display in a browser.Get the XSL style Tree as a text string suitable for display in a browser.getTreeAsText
(String treeURL) Get an XML document (or stylesheet)void
init()
Standard applet initialization.void
Do not call; this applet contains no UI or visual components.void
setDocumentURL
(String urlString) Set the URL to the XML document that will be transformed with the XSL stylesheet.void
setStyleSheetAttribute
(String nameOfIDAttrOfElemToModify, String elemId, String attrName, String value) Set an attribute in the stylesheet, which gives the ability to have some dynamic selection control.void
setStylesheetParam
(String key, String expr) Submit a stylesheet parameter.void
setStyleURL
(String urlString) Set the URL to the XSL stylesheet that will be used to transform the input XML.void
start()
Automatically called when the HTML client containing the applet loads.void
stop()
Automatically called when the HTML page containing the applet is no longer on the screen.transformToHtml
(String doc) Process a document and a stylesheet and return the transformation result.transformToHtml
(String doc, String style) Process a document and a stylesheet and return the transformation result.Methods inherited from class java.applet.Applet
getAccessibleContext, getAppletContext, getAudioClip, getAudioClip, getCodeBase, getDocumentBase, getImage, getImage, getLocale, getParameter, isActive, isValidateRoot, newAudioClip, play, play, resize, resize, setStub, showStatus
Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, update, validate
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, dispatchEvent, enable, enable, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
-
Constructor Details
-
XSLTProcessorApplet
public XSLTProcessorApplet()The XSLTProcessorApplet constructor takes no arguments.
-
-
Method Details
-
getAppletInfo
Get basic information about the applet- Overrides:
getAppletInfo
in classApplet
- Returns:
- A String with the applet name and author.
-
getParameterInfo
Get descriptions of the applet parameters.- Overrides:
getParameterInfo
in classApplet
- Returns:
- A two-dimensional array of Strings with Name, Type, and Description for each parameter.
-
init
public void init()Standard applet initialization. -
start
public void start()Automatically called when the HTML client containing the applet loads. This method starts execution of the applet thread. -
paint
Do not call; this applet contains no UI or visual components. -
stop
public void stop()Automatically called when the HTML page containing the applet is no longer on the screen. Stops execution of the applet thread. -
destroy
public void destroy()Cleanup; called when applet is terminated and unloaded. -
setStyleURL
Set the URL to the XSL stylesheet that will be used to transform the input XML. No processing is done yet.- Parameters:
urlString
- valid URL string for XSL stylesheet.
-
setDocumentURL
Set the URL to the XML document that will be transformed with the XSL stylesheet. No processing is done yet.- Parameters:
urlString
- valid URL string for XML document.
-
freeCache
public void freeCache()The processor keeps a cache of the source and style trees, so call this method if they have changed or you want to do garbage collection. -
setStyleSheetAttribute
public void setStyleSheetAttribute(String nameOfIDAttrOfElemToModify, String elemId, String attrName, String value) Set an attribute in the stylesheet, which gives the ability to have some dynamic selection control.- Parameters:
nameOfIDAttrOfElemToModify
- The name of an attribute to search for a unique id.elemId
- The unique ID to look for.attrName
- Once the element is found, the name of the attribute to set.value
- The value to set the attribute to.
-
setStylesheetParam
Submit a stylesheet parameter.- Parameters:
key
- stylesheet parameter keyexpr
- the parameter expression to be submitted.- See Also:
-
escapeString
Given a String containing markup, escape the markup so it can be displayed in the browser.- Parameters:
s
- String to escape The escaped string.
-
getHtmlText
Assuming the stylesheet URL and the input XML URL have been set, perform the transformation and return the result as a String.- Returns:
- A string that contains the contents pointed to by the URL.
-
getTreeAsText
Get an XML document (or stylesheet)- Parameters:
treeURL
- valid URL string for the document.- Returns:
- document
- Throws:
IOException
-
getSourceTreeAsText
Get the XML source Tree as a text string suitable for display in a browser. Note that this is for display of the XML itself, not for rendering of HTML by the browser.- Returns:
- XML source document as a string.
- Throws:
Exception
- thrown if tree can not be converted.
-
getStyleTreeAsText
Get the XSL style Tree as a text string suitable for display in a browser. Note that this is for display of the XML itself, not for rendering of HTML by the browser.- Returns:
- The XSL stylesheet as a string.
- Throws:
Exception
- thrown if tree can not be converted.
-
getResultTreeAsText
Get the HTML result Tree as a text string suitable for display in a browser. Note that this is for display of the XML itself, not for rendering of HTML by the browser.- Returns:
- Transformation result as unmarked text.
- Throws:
Exception
- thrown if tree can not be converted.
-
transformToHtml
Process a document and a stylesheet and return the transformation result. If one of these is null, the existing value (of a previous transformation) is not affected.- Parameters:
doc
- URL string to XML documentstyle
- URL string to XSL stylesheet- Returns:
- HTML transformation result
-
transformToHtml
Process a document and a stylesheet and return the transformation result. Use the xsl:stylesheet PI to find the document, if one exists.- Parameters:
doc
- URL string to XML document containing an xsl:stylesheet PI.- Returns:
- HTML transformation result
-