net.sf.cuf.ui

Class SwingMapping

java.lang.Object

net.sf.cuf.ui.SwingMapping

public class SwingMapping
extends Object

SwingMapping generates a string mapping for a tree of JComponent's.

This mapping is build upon the name property: starting from the root, all elements in the component tree that have a a non-null name property (all their parents must also have a non-null name property!) are mapped to name by concatenating the names of all components on the path separated with a "/".
As a special case, a Viewport inside a ScrollPane is silently skipped
After a mapping was constructed, components can be accessed by name, e.g. "myPanel/subPanel/okButton".

As a very useful feature ".." can be used inside a name to navigate to another component, e.g. "myPanel/subPanel/okButton/../textField" can be used to access a the component "textField" that is also a child of "subPanel". With this feature, it is very easy to access the "needed" components inside an ActionEvent callback. In addition to the hierarcical namespace a flat (but not uniq) namespace is provided.

Author:

Jürgen Zeller, jzeller@jzeller.eu

Method Summary

Methods

Modifier and Type	Method and Description
static SwingMapping	createMapping(JComponent pRoot) This factory method creates a new SwingMapping, starting from the handed root component.
JComponent	getByShortName(String pName) This method returns null or the component matching the handed short name.
JComponent	getComponentByName(String pName) This method returns null or the component matching the handed name after resolving ".." shortcuts.
String	getNameByComponent(JComponent pComponent) This method returns the full qualified name of the handed component.
String	toString() toString() generates a line-by-line description of all mappings, separated with " = " and containing first the full mapping name and second the class name of the mapped to object.

Methods inherited from class java.lang.Object

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

Method Detail

createMapping

public static SwingMapping createMapping(JComponent pRoot)

This factory method creates a new SwingMapping, starting from the handed root component.

Parameters:

pRoot - the root component

Returns:

a new SwingMapping

Throws:

IllegalArgumentException - if the names inside the component are not uniq or pRoot is null

getComponentByName

public JComponent getComponentByName(String pName)

This method returns null or the component matching the handed name after resolving ".." shortcuts.

Parameters:

pName - component name (may be null), inside the name all ".."'s are resolved first, so it is o.k. to use "somePanel/someButton/../someTextField" to get from any component to any other.

Returns:

null or the component that matches the (resolved) name

Throws:

IllegalArgumentException - the name is not resolvable due too many ".."'s

getByShortName

public JComponent getByShortName(String pName)

This method returns null or the component matching the handed short name. If there is more than one component with that short name, it is undefined which is return.

Parameters:

pName - component short name (may be null)

Returns:

null or the component that matches the (resolved) name

getNameByComponent

public String getNameByComponent(JComponent pComponent)

This method returns the full qualified name of the handed component.

Parameters:

pComponent - the component we want the name for

Returns:

null or the full qualified name of the component.

Throws:

IllegalArgumentException - if pComponent is not inside the hierarchy the SwingMapping object was created with

toString

public String toString()

toString() generates a line-by-line description of all mappings, separated with " = " and containing first the full mapping name and second the class name of the mapped to object.

Overrides:

toString in class Object

Returns:

complete map that is described with this mapping object