org.nuiton.jaxx.compiler.tags

Class DefaultComponentHandler

java.lang.Object

org.nuiton.jaxx.compiler.tags.DefaultObjectHandler

org.nuiton.jaxx.compiler.tags.DefaultComponentHandler

All Implemented Interfaces:

TagHandler

Direct Known Subclasses:

AbstractButtonHandler, JAXXComboBoxHandler, JAXXListHandler, JAXXTreeHandler, JComboBoxHandler, JInternalFrameHandler, JListHandler, JMenuHandler, JPopupMenuHandler, JProgressBarHandler, JScrollPaneHandler, JSliderHandler, JSpinnerHandler, JSplitPaneHandler, JTabbedPaneHandler, JTextComponentHandler, JToolBarHandler, JTreeHandler, JWindowHandler, JXLayerHandler, TableHandler

public class DefaultComponentHandler
extends DefaultObjectHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.nuiton.jaxx.compiler.tags.DefaultObjectHandler

DefaultObjectHandler.ProxyEventInfo

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_ICON_ATTRIBUTE
static String	BORDER_ATTRIBUTE
static String	BORDER_FACTORY_PREFIX
static String	CONTAINER_DELEGATE_ATTRIBUTE
static String	FONT_FACE_ATTRIBUTE
static String	FONT_SIZE_ATTRIBUTE
static String	FONT_STYLE_ATTRIBUTE
static String	FONT_WEIGHT_ATTRIBUTE
static String	HEIGHT_ATTRIBUTE
static String	I18N_MNEMONIC_ATTRIBUTE
static String	ICON_ATTRIBUTE
static String	ICON_IMAGE_ATTRIBUTE
protected static org.apache.logging.log4j.Logger	log Logger
static String	NAME_ATTRIBUTE
static String	TITLED_BORDER_ATTRIBUTE
static String	TITLED_BORDER_PREFIX
static String	WIDTH_ATTRIBUTE
static String	X_ATTRIBUTE
static String	Y_ATTRIBUTE

Fields inherited from class org.nuiton.jaxx.compiler.tags.DefaultObjectHandler

ABSTRACT_ATTRIBUTE, BORDER_LAYOUT_PREFIX, CONSTRAINTS_ATTRIBUTE, CONSTRUCTOR_PARAMS_ATTRIBUTE, DECORATOR_ATTRIBUTE, DISPLAYED_MNEMONIC_ATTRIBUTE, DISPLAYED_MNEMONIC_INDEX_ATTRIBUTE, GENERIC_TYPE_ATTRIBUTE, GRID_LAYOUT_PREFIX, HANDLER_ATTRIBUTE, I18N_ATTRIBUTE, I18N_PROPERTY_ATTRIBUTE, ID_ATTRIBUTE, IMPLEMENTS_ATTRIBUTE, INITIALIZER_ATTRIBUTE, JAVA_BEAN_ATTRIBUTE, jaxxBeanInfo, LAYOUT_ATTRIBUTE, MNEMONIC_ATTRIBUTE, objectMap, STYLE_CLASS_ATTRIBUTE, SUPER_GENERIC_TYPE_ATTRIBUTE

Fields inherited from interface org.nuiton.jaxx.compiler.tags.TagHandler

XMLNS_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
DefaultComponentHandler(ClassDescriptor beanClass)

Method Summary

Modifier and Type	Method and Description
protected void	closeComponent(CompiledObject object, Element tag, JAXXCompiler compiler)
void	compileFirstPass(Element tag, JAXXCompiler compiler) Performs the first pass of compilation on an XML tag from a JAXX source file.
void	compileSecondPass(Element tag, JAXXCompiler compiler) Performs the second pass of compilation on an XML tag from a JAXX source file.
protected void	configureProxyEventInfo() Configures the event handling for members which do not fire PropertyChangeEvent when modified.
protected int	constantValue(String key, String value) Maps string values onto integers, so that int-valued enumeration properties can be specified by strings.
String	getContainerDelegate()
String	getGetPropertyCode(String id, String name, JAXXCompiler compiler) Returns a snippet of Java code which will retrieve an object property at runtime.
ClassDescriptor	getPropertyType(CompiledObject object, String propertyName, JAXXCompiler compiler) Returns the type of the named property.
String	getSetPropertyCode(String id, String name, String valueCode, JAXXCompiler compiler) Returns a snippet of Java code which will set an object property at runtime.
protected void	init() Performs introspection on the beanClass and stores the results.
boolean	isContainer() Returns true if this component can contain other components.
boolean	isPropertyInherited(String property)
protected void	openComponent(CompiledObject object, Element tag, JAXXCompiler compiler)
protected void	scanAttributesForDependencies(Element tag, JAXXCompiler compiler) Scans all attributes for any dependency classes and adds them to the current compilation set.
void	setAttribute(CompiledObject object, String propertyName, String stringValue, boolean inline, JAXXCompiler compiler) Set a single property on an object.
protected void	setDefaults(CompiledObject object, Element tag, JAXXCompiler compiler) Initializes the default settings of the object, prior to setting its attribute values.

Methods inherited from class org.nuiton.jaxx.compiler.tags.DefaultObjectHandler

addEventHandler, addProxyEventInfo, addProxyEventInfo, addProxyEventInfo, addProxyEventInfo, applyStylesheets, compileChildrenFirstPass, compileChildrenSecondPass, compileChildTagFirstPass, compileChildTagSecondPass, convertFromString, createCompiledObject, getAttributeComparator, getAttributeOrdering, getBeanClass, getEventClass, getEventInfo, getJAXXBeanInfo, getJAXXBeanInfo, isEventHandlerName, isMemberBound, registerCompiledObject, safeInit, setAttributeFromCss, setAttributes, setProperty, toString

Methods inherited from class java.lang.Object

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

Field Detail

BORDER_ATTRIBUTE

public static final String BORDER_ATTRIBUTE

See Also:

Constant Field Values

TITLED_BORDER_ATTRIBUTE

public static final String TITLED_BORDER_ATTRIBUTE

See Also:

Constant Field Values

ACTION_ICON_ATTRIBUTE

public static final String ACTION_ICON_ATTRIBUTE

See Also:

Constant Field Values

I18N_MNEMONIC_ATTRIBUTE

public static final String I18N_MNEMONIC_ATTRIBUTE

See Also:

Constant Field Values

CONTAINER_DELEGATE_ATTRIBUTE

public static final String CONTAINER_DELEGATE_ATTRIBUTE

See Also:

Constant Field Values

FONT_FACE_ATTRIBUTE

public static final String FONT_FACE_ATTRIBUTE

See Also:

Constant Field Values

FONT_SIZE_ATTRIBUTE

public static final String FONT_SIZE_ATTRIBUTE

See Also:

Constant Field Values

FONT_STYLE_ATTRIBUTE

public static final String FONT_STYLE_ATTRIBUTE

See Also:

Constant Field Values

FONT_WEIGHT_ATTRIBUTE

public static final String FONT_WEIGHT_ATTRIBUTE

See Also:

Constant Field Values

HEIGHT_ATTRIBUTE

public static final String HEIGHT_ATTRIBUTE

See Also:

Constant Field Values

ICON_ATTRIBUTE

public static final String ICON_ATTRIBUTE

See Also:

Constant Field Values

ICON_IMAGE_ATTRIBUTE

public static final String ICON_IMAGE_ATTRIBUTE

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

See Also:

Constant Field Values

WIDTH_ATTRIBUTE

public static final String WIDTH_ATTRIBUTE

See Also:

Constant Field Values

X_ATTRIBUTE

public static final String X_ATTRIBUTE

See Also:

Constant Field Values

Y_ATTRIBUTE

public static final String Y_ATTRIBUTE

See Also:

Constant Field Values

log

protected static final org.apache.logging.log4j.Logger log

Logger

BORDER_FACTORY_PREFIX

public static final String BORDER_FACTORY_PREFIX

TITLED_BORDER_PREFIX

public static final String TITLED_BORDER_PREFIX

Constructor Detail

DefaultComponentHandler

public DefaultComponentHandler(ClassDescriptor beanClass)

Method Detail

init

protected void init()
             throws IntrospectionException

Description copied from class: DefaultObjectHandler

Performs introspection on the beanClass and stores the results.

Overrides:

init in class DefaultObjectHandler

Throws:

IntrospectionException - if any pb

configureProxyEventInfo

protected void configureProxyEventInfo()

Description copied from class: DefaultObjectHandler

Configures the event handling for members which do not fire PropertyChangeEvent when modified. The default implementation does nothing. Subclasses should override this method to call addProxyEventInfo for each member which requires special handling.

Overrides:

configureProxyEventInfo in class DefaultObjectHandler

setDefaults

protected void setDefaults(CompiledObject object,
                           Element tag,
                           JAXXCompiler compiler)
                    throws CompilerException

Description copied from class: DefaultObjectHandler

Initializes the default settings of the object, prior to setting its attribute values. The default implementation does nothing.

Overrides:

setDefaults in class DefaultObjectHandler

Parameters:

object - the object to initialize

tag - the tag being compiled

compiler - the current JAXXCompiler

Throws:

CompilerException

compileFirstPass

public void compileFirstPass(Element tag,
                             JAXXCompiler compiler)
                      throws CompilerException,
                             IOException

Description copied from interface: TagHandler

Performs the first pass of compilation on an XML tag from a JAXX source file. TagHandler implementations affect the generated .java file by calling methods in the JAXXCompiler.

Specified by:

compileFirstPass in interface TagHandler

Overrides:

compileFirstPass in class DefaultObjectHandler

Parameters:

tag - the XML tag to compile

compiler - the active JAXXCompiler

Throws:

CompilerException - if a compilation error occurs

IOException - if an I/O error occurs

compileSecondPass

public void compileSecondPass(Element tag,
                              JAXXCompiler compiler)
                       throws CompilerException,
                              IOException

Description copied from interface: TagHandler

Performs the second pass of compilation on an XML tag from a JAXX source file. TagHandler implementations affect the generated .java file by calling methods in the JAXXCompiler.

Specified by:

compileSecondPass in interface TagHandler

Overrides:

compileSecondPass in class DefaultObjectHandler

Parameters:

tag - the XML tag to compile

compiler - the active JAXXCompiler

Throws:

CompilerException - if a compilation error occurs

IOException - if an I/O error occurs

openComponent

protected void openComponent(CompiledObject object,
                             Element tag,
                             JAXXCompiler compiler)
                      throws CompilerException

Throws:

CompilerException

closeComponent

protected void closeComponent(CompiledObject object,
                              Element tag,
                              JAXXCompiler compiler)
                       throws CompilerException

Throws:

CompilerException

isPropertyInherited

public boolean isPropertyInherited(String property)
                            throws UnsupportedAttributeException

Overrides:

isPropertyInherited in class DefaultObjectHandler

Parameters:

property - property name to test

Returns:

true if the specified property should be inherited by child components when specified via CSS.

Throws:

UnsupportedAttributeException - if attribute is not supported

getPropertyType

public ClassDescriptor getPropertyType(CompiledObject object,
                                       String propertyName,
                                       JAXXCompiler compiler)
                                throws CompilerException

Description copied from class: DefaultObjectHandler

Returns the type of the named property. This is the return type of the property's get method; for instance JLabel's text property is a String.

Overrides:

getPropertyType in class DefaultObjectHandler

Parameters:

object - the object being compiled

propertyName - the simple JavaBeans-style name of the property

compiler - the current JAXXCompiler

Returns:

the property's type

Throws:

CompilerException - if the type cannot be determined

getGetPropertyCode

public String getGetPropertyCode(String id,
                                 String name,
                                 JAXXCompiler compiler)
                          throws CompilerException

Description copied from class: DefaultObjectHandler

Returns a snippet of Java code which will retrieve an object property at runtime. Typically the code is just a call to the property's get method, but it can be arbitrarily complex.

Overrides:

getGetPropertyCode in class DefaultObjectHandler

Parameters:

id - Java code for the object whose property is being retrieved

name - the name of the property to retrieve

compiler - the current JAXXCompiler

Returns:

the snippet

Throws:

CompilerException - if a compilation error occurs

getSetPropertyCode

public String getSetPropertyCode(String id,
                                 String name,
                                 String valueCode,
                                 JAXXCompiler compiler)
                          throws CompilerException

Description copied from class: DefaultObjectHandler

Returns a snippet of Java code which will set an object property at runtime. Typically the code is just a call to the property's set method, but it can be arbitrarily complex.

Overrides:

getSetPropertyCode in class DefaultObjectHandler

Parameters:

id - Java code for the object whose property is being set

name - the name of the property to set

valueCode - Java expression representing the value to set the property to

compiler - the current JAXXCompiler

Returns:

the snippet

Throws:

CompilerException - if a compilation error occurs

setAttribute

public void setAttribute(CompiledObject object,
                         String propertyName,
                         String stringValue,
                         boolean inline,
                         JAXXCompiler compiler)

Description copied from class: DefaultObjectHandler

Set a single property on an object. The value may be either a simple value or contain data binding expressions. Simple values are first converted to the property's type using DefaultObjectHandler.convertFromString(String, String, Class).

Overrides:

setAttribute in class DefaultObjectHandler

Parameters:

object - the object on which to set the property

propertyName - the name of the property to set

stringValue - the raw string value of the property from the XML

inline - true if the value was directly specified as an inline class tag attribute, false otherwise (a default value, specified in CSS, etc.)

compiler - the current JAXXCompiler

scanAttributesForDependencies

protected void scanAttributesForDependencies(Element tag,
                                             JAXXCompiler compiler)

Description copied from class: DefaultObjectHandler

Scans all attributes for any dependency classes and adds them to the current compilation set. Called by compileFirstPass() (it is an error to add dependencies after pass 1 is complete).

Overrides:

scanAttributesForDependencies in class DefaultObjectHandler

Parameters:

tag - tag to scan

compiler - compiler to use

constantValue

protected int constantValue(String key,
                            String value)

Maps string values onto integers, so that int-valued enumeration properties can be specified by strings. For example, when passed a key of 'alignment', this method should normally map the values 'left', 'center', and 'right' onto SwingConstants.LEFT, SwingConstants.CENTER, and SwingConstants.RIGHT respectively.

You do not normally need to call this method yourself; it is invoked by DefaultObjectHandler.convertFromString(java.lang.String, java.lang.String, java.lang.Class<?>) when an int-valued property has a value which is not a valid number. By default, this method looks at the enumerationValues value of the JAXXPropertyDescriptor.

Overrides:

constantValue in class DefaultObjectHandler

Parameters:

key - the name of the int-typed property

value - the non-numeric value that was specified for the property

Returns:

the constant integer value

Throws:

IllegalArgumentException - if the property is an enumeration, but the value is not valid

NumberFormatException - if the property is not an enumeration

isContainer

public boolean isContainer()

Returns true if this component can contain other components. For children to be allowed, the component must be a subclass of Container and its JAXXBeanInfo must not have the value false for its isContainer value.

Returns:

true if children are allowed

getContainerDelegate

public String getContainerDelegate()