net.xoetrope.swing
Class XMetaContent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  net.xoetrope.swing.XMetaContent

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, XStyleComponent, XAttributedComponent, XMetaContentHolder

public class XMetaContent

extends javax.swing.JPanel

implements XMetaContentHolder, XStyleComponent, XAttributedComponent

This component renders XML based content. A simple set of tags for layout and formatting are used. Styles can be used to control attributes such as fonts and colors

For example the following taken from the Xui Zoo sample application shows some formatted paragraphs of text:

   Congratulations!

 You have just been appointed general manager of the XUI Zoo.

 Unfortunately your predescessor wasted most of his time struggling with his Java code. To keep the zoo in business you must buy some new animals quickly. You need to buy 100  animals, including Monkies, Elephants and to get new visitors to the zoo you need to have at least one amazing Unicorn.

 Monkies are common enough and only cost 0.05 $XML, Elephants on the other hand are big animals and cost a full 1.00 $XML. And the most rare Unicorns cost the princely sum of  5.00 $XML

 Please fill in your order quantities below. 
 

The tag supported by this class are listed below and play a similar role to their html equivalents:

• XSTYLE - sets the style for the text.
• BR - A break.
• UL - A unordered list.
• LI - A list item.
• TABLE - A table.
• TD - A table cell declaration.
• TR - A table record/row declaration.

  The tags can be nested as you would do whith HTML.

  Copyright (c) Xoetrope Ltd., 1998-2004
  License: see license.txt

  See Also:

  Serialized Form

  ---

  Nested Class Summary

   

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

   

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

   

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

   

  Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

   

  Field Summary
  protected static java.util.Hashtable	methodTable           A table of the method names needed for rendereing each style

   

  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
  XMetaContent()           Constructs anew XMetaContent component

   

  Method Summary
  void	calcSize()           Calcualte the size of the content.
  protected  void	fillMethodTable()           Initialises the lookup hash table of handlers for the content.
  java.lang.String	getContent()           Get the meta content's name .
  java.lang.String	getFileName()           Get the source of the current content
  void	paintComponent(java.awt.Graphics g)           Renders the component
  protected  boolean	renderItem(java.awt.Graphics g, XmlElement child, int method)           Renders an individual item/tag
  void	setAttribute(java.lang.String attribName, java.lang.String attribValue)           Set one or more attributes of the component.
  void	setBounds(int x, int y, int w, int h)           Sets the bounds for this component
  void	setContent(java.lang.String newContent)           Set the meta content to a simple string value
  void	setContent(java.lang.String xmlSrc, XmlElement src)           Set the meta content.
  void	setFileName(java.lang.String fileName)           Set the meta content to the content of an xml file
  void	setPadding(int pad)           Sets the padding or indent for the content
  void	setStyle(java.lang.String style)           Set the current style.
  void	setUsesLaf(boolean value)           Set the painting of the background

   

  Methods inherited from class javax.swing.JPanel
  getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

   

  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, 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, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, 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, 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, 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, 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, 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

   

  Field Detail

  methodTable

  protected static java.util.Hashtable methodTable

  A table of the method names needed for rendereing each style

  Constructor Detail

  XMetaContent

  public XMetaContent()

  Constructs anew XMetaContent component

  Method Detail

  fillMethodTable

  protected void fillMethodTable()

  Initialises the lookup hash table of handlers for the content. The hash table provides a quick way of looking up the tag names for subsequent use in a switch.

  ---

  setFileName

  public void setFileName(java.lang.String fileName)

  Set the meta content to the content of an xml file

  Parameters:

  fileName - the new content

  ---

  setContent

  public void setContent(java.lang.String newContent)

  Set the meta content to a simple string value

  Parameters:

  newContent - the new content

  ---

  setContent

  public void setContent(java.lang.String xmlSrc,
                         XmlElement src)

  Set the meta content.

  Specified by:

  setContent in interface XMetaContentHolder

  Parameters:

  xmlSrc - the input location

  src - the input xml element

  ---

  getFileName

  public java.lang.String getFileName()

  Get the source of the current content

  Returns:

  the file name

  ---

  getContent

  public java.lang.String getContent()

  Get the meta content's name .

  Returns:

  the model name of the content

  ---

  paintComponent

  public void paintComponent(java.awt.Graphics g)

  Renders the component

  Overrides:

  paintComponent in class javax.swing.JComponent

  Parameters:

  g - the graphics context

  ---

  setPadding

  public void setPadding(int pad)

  Sets the padding or indent for the content

  Parameters:

  pad - the amount of padding in pixels

  ---

  calcSize

  public void calcSize()

  Calcualte the size of the content. This method is called from within the paint method and recalculates the required size for display of the content. If a scrollpane is the parent then this control is resized so that all the content will be visible. The scrollpane may initially have no scrollbar so to avoid flicker and multiple repaints as the control is sized and offscreen graphics context is used for the sizing.

  ---

  renderItem

  protected boolean renderItem(java.awt.Graphics g,
                               XmlElement child,
                               int method)

  Renders an individual item/tag

  Parameters:

  g - the graphics context

  child - the xml element being rendered

  method - the element name

  Returns:

  true if the item was rendered

  ---

  setStyle

  public void setStyle(java.lang.String style)

  Set the current style.

  Specified by:

  setStyle in interface XStyleComponent

  Parameters:

  style - the style to use when renderer

  ---

  setBounds

  public void setBounds(int x,
                        int y,
                        int w,
                        int h)

  Sets the bounds for this component

  Overrides:

  setBounds in class java.awt.Component

  Parameters:

  x - the left coordinate

  y - the top/y coordinate

  w - the width

  h - the height

  ---

  setUsesLaf

  public void setUsesLaf(boolean value)

  Set the painting of the background

  Parameters:

  value - true to have the LAF paint the background or false for the component to paint it itself using the colours specified in the styles (if any)

  ---

  setAttribute

  public void setAttribute(java.lang.String attribName,
                           java.lang.String attribValue)

  Set one or more attributes of the component.

  1. laf value=(true|false) rely on the look and feel to paint the background
  2. opaque value=(true|false) false to rely on the parent component to paint the background

  Specified by:

  setAttribute in interface XAttributedComponent

  Parameters:

  attribName - the attribute name

  attribValue - the attribute value

  ---

  Overview  Package   Class  Use  Tree  Deprecated  Index  Help
  PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
  SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

  ---