SwingMetawidget (Metawidget API Documentation)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - org.metawidget.swing.SwingMetawidget

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable
```
public class SwingMetawidget
extends JComponent
```
Metawidget for Swing environments.

Author:

Richard Kennard

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class SwingMetawidget.Pipeline
- 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

Nested Classes
Modifier and Type	Class and Description
`protected class`	`SwingMetawidget.Pipeline`

Field Summary
- 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

Constructors
Constructor and Description

SwingMetawidget()

Constructors
Constructor and Description
`SwingMetawidget()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addImpl(Component component, Object constraints, int index)`
`void`	`addInspectionResultProcessor(InspectionResultProcessor<SwingMetawidget> inspectionResultProcessor)`
`void`	`addNotify()` Overridden to build widgets just-in-time.
`void`	`addWidgetProcessor(WidgetProcessor<JComponent,SwingMetawidget> widgetProcessor)`
`protected void`	`buildWidgets()`
`protected void`	`endBuild()`
`List<JComponent>`	`fetchExistingUnusedComponents()` Fetch a list of `JComponents` that were added manually, and have so far not been used.
`Rectangle`	`getBounds(Rectangle rectangle)` Overridden to build widgets just-in-time.
`Component`	`getComponent(int index)` Overridden to build widgets just-in-time.
`<T extends Component> T`	`getComponent(String... names)` Finds the Component with the given name.
`int`	`getComponentCount()` Overridden to build widgets just-in-time.
`Component[]`	`getComponents()` Overridden to build widgets just-in-time.
`protected String`	`getDefaultConfiguration()`
`Facet`	`getFacet(String name)`
`String`	`getLabelString(Map<String,String> attributes)` Returns a label for the given set of attributes.
`LayoutManager`	`getLayout()` Overridden to build widgets just-in-time.
`String`	`getLocalizedKey(String key)`
`int`	`getMaximumInspectionDepth()`
`Layout<JComponent,JComponent,SwingMetawidget>`	`getMetawidgetLayout()`
`String`	`getPath()`
`Dimension`	`getPreferredSize()` Overridden to build widgets just-in-time.
`<T> T`	`getToInspect()` Gets the Object being inspected.
`<T> T`	`getValue(String... names)` Gets the value from the Component with the given name.
`String`	`getValueProperty(Component component)` Returns the property used to get/set the value of the component.
`WidgetBuilder<JComponent,SwingMetawidget>`	`getWidgetBuilder()`
`<T> T`	`getWidgetProcessor(Class<T> widgetProcessorClass)`
`void`	`initNestedMetawidget(SwingMetawidget nestedMetawidget, Map<String,String> attributes)` Useful for WidgetBuilders to setup nested Metawidgets (eg.
`String`	`inspect(Object toInspect, String type, String... names)` Useful for WidgetBuilders to perform nested inspections (eg.
`protected void`	`invalidateInspection()` Invalidates the current inspection result (if any) and invalidates the widgets.
`protected void`	`invalidateWidgets()` Invalidates the widgets.
`boolean`	`isReadOnly()`
`protected void`	`layoutWidget(Component component, String elementName, Map<String,String> attributes)`
`protected SwingMetawidget.Pipeline`	`newPipeline()` Instantiate the Pipeline used by this Metawidget.
`protected void`	`paintComponent(Graphics graphics)`
`void`	`remove(Component component)`
`void`	`remove(int index)`
`void`	`removeAll()`
`void`	`removeInspectionResultProcessor(InspectionResultProcessor<SwingMetawidget> inspectionResultProcessor)`
`void`	`removeWidgetProcessor(WidgetProcessor<JComponent,SwingMetawidget> widgetProcessor)`
`void`	`setBounds(Rectangle rectangle)` Overridden to build widgets just-in-time.
`void`	`setBundle(ResourceBundle bundle)`
`void`	`setConfig(String config)`
`void`	`setInspectionResultProcessors(InspectionResultProcessor<SwingMetawidget>... inspectionResultProcessors)`
`void`	`setInspector(Inspector inspector)`
`void`	`setMaximumInspectionDepth(int maximumInspectionDepth)`
`void`	`setMetawidgetLayout(Layout<JComponent,JComponent,SwingMetawidget> layout)` Set the layout for this Metawidget.
`void`	`setPath(String path)` Sets the path to be inspected.
`void`	`setReadOnly(boolean readOnly)`
`void`	`setToInspect(Object toInspect)` Sets the Object to inspect.
`void`	`setValue(Object value, String... names)` Sets the Component with the given name to the specified value.
`void`	`setWidgetBuilder(WidgetBuilder<JComponent,SwingMetawidget> widgetBuilder)`
`void`	`setWidgetProcessors(WidgetProcessor<JComponent,SwingMetawidget>... widgetProcessors)`
`protected void`	`startBuild()`
`void`	`updateToInspectWithoutInvalidate(Object toInspect)` Updates the Object to inspect, without invalidating the previous inspection results.

Methods inherited from class javax.swing.JComponent
addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, 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, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponentAt, getComponentAt, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SwingMetawidget
```
public SwingMetawidget()
```
- Method Detail
  - setToInspect
```
public void setToInspect(Object toInspect)
```
    Sets the Object to inspect.
    If setPath has not been set, or points to a previous setToInspect, sets it to point to the given Object.
  - updateToInspectWithoutInvalidate
```
public void updateToInspectWithoutInvalidate(Object toInspect)
```
    Updates the Object to inspect, without invalidating the previous inspection results.
    This is an internal API exposed for WidgetProcessor rebinding support. Clients should not call it directly.
  - getToInspect
```
public <T> T getToInspect()
```
    Gets the Object being inspected.
    Exposed for binding implementations.
    
    Returns:
    the object. Note this return type uses generics, so as to not require a cast by the caller (eg. Person p = getToInspect())
  - setPath
```
public void setPath(String path)
```
    Sets the path to be inspected.
    Note setPath is quite different to java.awt.Component.setName. setPath is always in relation to setToInspect, so must include the type name and any subsequent sub-names (eg. type/name/name). Conversely, setName is a single name relative to our immediate parent.
  - getPath
```
public String getPath()
```
  - setConfig
```
public void setConfig(String config)
```
  - setInspector
```
public void setInspector(Inspector inspector)
```
  - inspect
```
public String inspect(Object toInspect,
             String type,
             String... names)
```
    Useful for WidgetBuilders to perform nested inspections (eg. for Collections).
  - addInspectionResultProcessor
```
public void addInspectionResultProcessor(InspectionResultProcessor<SwingMetawidget> inspectionResultProcessor)
```
  - removeInspectionResultProcessor
```
public void removeInspectionResultProcessor(InspectionResultProcessor<SwingMetawidget> inspectionResultProcessor)
```
  - setInspectionResultProcessors
```
public void setInspectionResultProcessors(InspectionResultProcessor<SwingMetawidget>... inspectionResultProcessors)
```
  - setWidgetBuilder
```
public void setWidgetBuilder(WidgetBuilder<JComponent,SwingMetawidget> widgetBuilder)
```
  - getWidgetBuilder
```
public WidgetBuilder<JComponent,SwingMetawidget> getWidgetBuilder()
```
  - addWidgetProcessor
```
public void addWidgetProcessor(WidgetProcessor<JComponent,SwingMetawidget> widgetProcessor)
```
  - removeWidgetProcessor
```
public void removeWidgetProcessor(WidgetProcessor<JComponent,SwingMetawidget> widgetProcessor)
```
  - setWidgetProcessors
```
public void setWidgetProcessors(WidgetProcessor<JComponent,SwingMetawidget>... widgetProcessors)
```
  - getWidgetProcessor
```
public <T> T getWidgetProcessor(Class<T> widgetProcessorClass)
```
  - setMetawidgetLayout
```
public void setMetawidgetLayout(Layout<JComponent,JComponent,SwingMetawidget> layout)
```
    Set the layout for this Metawidget.
    Named setMetawidgetLayout, rather than the usual setLayout, because Swing already defines a setLayout. Overloading Swing's setLayout was considered cute, but ultimately confusing and dangerous. For example, what should setLayout( null ) do?
  - getMetawidgetLayout
```
public Layout<JComponent,JComponent,SwingMetawidget> getMetawidgetLayout()
```
  - setBundle
```
public void setBundle(ResourceBundle bundle)
```
  - getLabelString
```
public String getLabelString(Map<String,String> attributes)
```
    Returns a label for the given set of attributes.
    The label is determined using the following algorithm:
    - if attributes.get( "label" ) exists...
      
      attributes.get( "label" ) is camel-cased and used as a lookup into getLocalizedKey( camelCasedLabel ). This means developers can initially build their UIs without worrying about localization, then turn it on later
      
      if no such lookup exists, return attributes.get( "label" )
    - if attributes.get( "label" ) does not exist...
      
      attributes.get( "name" ) is used as a lookup into getLocalizedKey( name )
      
      if no such lookup exists, return attributes.get( "name" )
    Returns:
    the label string. Empty if no such name. Null if name has been forced to blank (i.e. should be hidden)
  - getLocalizedKey
```
public String getLocalizedKey(String key)
```
    Returns:
    null if no bundle, ???key??? if bundle is missing a key
  - isReadOnly
```
public boolean isReadOnly()
```
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
```
  - getMaximumInspectionDepth
```
public int getMaximumInspectionDepth()
```
  - setMaximumInspectionDepth
```
public void setMaximumInspectionDepth(int maximumInspectionDepth)
```
  - fetchExistingUnusedComponents
```
public List<JComponent> fetchExistingUnusedComponents()
```
    Fetch a list of JComponents that were added manually, and have so far not been used.
    This is an internal API exposed for OverriddenWidgetBuilder. Clients should not call it directly.
  - getPreferredSize
```
public Dimension getPreferredSize()
```
    Overridden to build widgets just-in-time.
    This is the first method a JFrame.pack calls.
    
    Overrides:
    
    getPreferredSize in class JComponent
  - setBounds
```
public void setBounds(Rectangle rectangle)
```
    Overridden to build widgets just-in-time.
    This is the first method a JTable.editCellAt calls.
    
    Overrides:
    
    setBounds in class Component
  - getBounds
```
public Rectangle getBounds(Rectangle rectangle)
```
    Overridden to build widgets just-in-time.
    This is the first method a JComponent.paintChildren calls (this includes JDialog)
    
    Overrides:
    
    getBounds in class JComponent
  - getComponent
```
public Component getComponent(int index)
```
    Overridden to build widgets just-in-time.
    This method may be called by developers who wish to modify the created Components before they are displayed. For example, they may wish to call .setBorder( null ) if the component is to be used as a JTable CellEditor.
    
    Overrides:
    
    getComponent in class Container
  - getComponents
```
public Component[] getComponents()
```
    Overridden to build widgets just-in-time.
    This method may be called by developers who wish to modify the created Components before they are displayed. For example, they may wish to call .setBorder( null ) if the component is to be used as a JTable CellEditor.
    
    Overrides:
    
    getComponents in class Container
  - getComponentCount
```
public int getComponentCount()
```
    Overridden to build widgets just-in-time.
    This method may be called by developers who wish to modify the created Components before they are displayed.
    
    Overrides:
    
    getComponentCount in class Container
  - getLayout
```
public LayoutManager getLayout()
```
    Overridden to build widgets just-in-time.
    This method may be called by developers who wish to test the SwingMetawidget's active LayoutManager.
    
    Overrides:
    
    getLayout in class Container
  - addNotify
```
public void addNotify()
```
    Overridden to build widgets just-in-time.
    When adding a Stub that immediately stubs out a widget and therefore disappears from the component list, we must override addNotify to build widgets or else Swing gets confused trying to addNotify a component that isn't there.
    See SwingTutorialTest.testAddNotify.
    
    Overrides:
    
    addNotify in class JComponent
  - getValue
```
public <T> T getValue(String... names)
```
    Gets the value from the Component with the given name.
    The value is returned as it was stored in the Component (eg. String for JTextField) so may need some conversion before being reapplied to the object being inspected. This obviously requires knowledge of which Component SwingMetawidget created, which is not ideal, so clients may prefer to use a binding WidgetProcessor instead.
    
    Returns:
    the value. Note this return type uses generics, so as to not require a cast by the caller (eg. String s = getValue(names))
  - setValue
```
public void setValue(Object value,
            String... names)
```
    Sets the Component with the given name to the specified value.
    Clients must ensure the value is of the correct type to suit the Component (eg. String for JTextField). This obviously requires knowledge of which Component SwingMetawidget created, which is not ideal, so clients may prefer to use a binding WidgetProcessor instead.
  - getValueProperty
```
public String getValueProperty(Component component)
```
    Returns the property used to get/set the value of the component.
    If the component is not known, returns null. Does not throw an Exception, as we want to fail gracefully if, say, someone tries to bind to a JPanel.
  - getComponent
```
public <T extends Component> T getComponent(String... names)
```
    Finds the Component with the given name.
  - getFacet
```
public Facet getFacet(String name)
```
  - remove
```
public void remove(Component component)
```
    Overrides:
    
    remove in class Container
  - remove
```
public void remove(int index)
```
    Overrides:
    
    remove in class Container
  - removeAll
```
public void removeAll()
```
    Overrides:
    
    removeAll in class Container
  - initNestedMetawidget
```
public void initNestedMetawidget(SwingMetawidget nestedMetawidget,
                        Map<String,String> attributes)
```
    Useful for WidgetBuilders to setup nested Metawidgets (eg. for initializing a dummy Metawidget to rebind child Metawidgets in a Collection).
  - newPipeline
```
protected SwingMetawidget.Pipeline newPipeline()
```
    Instantiate the Pipeline used by this Metawidget.
    Subclasses wishing to use their own Pipeline should override this method to instantiate their version.
  - getDefaultConfiguration
```
protected String getDefaultConfiguration()
```
  - paintComponent
```
protected void paintComponent(Graphics graphics)
```
    Overrides:
    
    paintComponent in class JComponent
  - invalidateInspection
```
protected void invalidateInspection()
```
    Invalidates the current inspection result (if any) and invalidates the widgets.
    As an optimisation we only invalidate the widgets, not the entire inspection result, for some operations (such as adding/removing stubs, changing read-only etc.)
  - invalidateWidgets
```
protected void invalidateWidgets()
```
    Invalidates the widgets.
  - addImpl
```
protected void addImpl(Component component,
           Object constraints,
           int index)
```
    Overrides:
    
    addImpl in class Container
  - buildWidgets
```
protected void buildWidgets()
```
  - startBuild
```
protected void startBuild()
```
  - layoutWidget
```
protected void layoutWidget(Component component,
                String elementName,
                Map<String,String> attributes)
```
    Parameters:
    elementName - XML node name of the business field. Typically 'entity', 'property' or 'action'. Never null
  - endBuild
```
protected void endBuild()
```

Class SwingMetawidget

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Constructor Detail

SwingMetawidget

Method Detail

setToInspect

updateToInspectWithoutInvalidate

getToInspect

setPath

getPath

setConfig

setInspector

inspect

addInspectionResultProcessor

removeInspectionResultProcessor

setInspectionResultProcessors

setWidgetBuilder

getWidgetBuilder

addWidgetProcessor

removeWidgetProcessor

setWidgetProcessors

getWidgetProcessor

setMetawidgetLayout

getMetawidgetLayout

setBundle

getLabelString

getLocalizedKey

isReadOnly

setReadOnly

getMaximumInspectionDepth

setMaximumInspectionDepth

fetchExistingUnusedComponents

getPreferredSize

setBounds

getBounds

getComponent

getComponents

getComponentCount

getLayout

addNotify

getValue

setValue

getValueProperty

getComponent

getFacet

remove

remove

removeAll

initNestedMetawidget

newPipeline

getDefaultConfiguration

paintComponent

invalidateInspection

invalidateWidgets

addImpl

buildWidgets

startBuild

layoutWidget

endBuild