Module org.autogui

Package org.autogui.swing

Class GuiSwingMapperSet

java.lang.Object

org.autogui.swing.GuiSwingMapperSet

public class GuiSwingMapperSet
extends Object

a set of mapping between GuiRepresentation and GuiSwingElement. The default set is provided by getDefaultMapperSet().

The class also provides default set of GuiRepresentations as getReprDefaultSet(), which is an extended version of GuiRepresentation.getDefaultSet().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuiSwingMapperSet.Mapper	a mapping between GuiRepresentation bound to a GuiMappingContext and GuiSwingElement.
static interface	GuiSwingMapperSet.MapperMatchType	the interface definition of mapping type
static enum	GuiSwingMapperSet.MapperMatchTypeDefault	a concrete definition of mapper type
static class	GuiSwingMapperSet.MapperReprClass	a mapping between a representation of a class and a view with a mapping type

Field Summary

Fields

Modifier and Type	Field	Description
protected static GuiSwingMapperSet	defaultMapperSet
protected List<GuiSwingMapperSet.Mapper>	mappers
protected static GuiReprSet	reprDefaultSet

Constructor Summary

Constructors

Constructor	Description
GuiSwingMapperSet()

Method Summary

Modifier and Type	Method	Description
GuiSwingMapperSet	add(GuiSwingMapperSet.Mapper... mappers)
static void	addDefaultReprClassesTo(GuiSwingMapperSet viewSet)	provide a default set of mappings between a representation and a view.
static void	addDefaultReprSetTo(GuiReprSet reprSet)	provide a default set of representations.
GuiSwingMapperSet	addReprClass(Class<? extends GuiRepresentation> reprClass, GuiSwingElement view)	register a mapping of reprClass and a regular view with the type GuiSwingMapperSet.MapperMatchTypeDefault.View
GuiSwingMapperSet	addReprClassTableColumn(Class<? extends GuiRepresentation> reprClass, GuiSwingElement view)	register a mapping of reprClass and a column view with the type GuiSwingMapperSet.MapperMatchTypeDefault.TableColumn
GuiSwingMapperSet	addReprClassTableColumnToTop(Class<? extends GuiRepresentation> reprClass, GuiSwingElement view)	register a mapping of reprClass and a column view with the type GuiSwingMapperSet.MapperMatchTypeDefault.TableColumn as top-precedence
GuiSwingMapperSet	addReprClassToTop(Class<? extends GuiRepresentation> reprClass, GuiSwingElement view)	register a mapping of reprClass and a regular view with the type GuiSwingMapperSet.MapperMatchTypeDefault.View as top-precedence
static GuiReprEmbeddedComponent	createEmbeddedComponent()
static GuiReprValueDocumentEditor	createValueDocumentEditor()
static GuiReprValueImagePane	createValueImagePane(boolean processGlobal)
static GuiSwingMapperSet	getDefaultMapperSet()
List<GuiSwingMapperSet.Mapper>	getMappers()
static GuiReprSet	getReprDefaultSet()
GuiSwingElement	view(GuiMappingContext context)
GuiSwingElement	view(GuiMappingContext context, GuiSwingMapperSet.MapperMatchType matchType)
GuiSwingElement	viewTableColumn(GuiMappingContext context)

Methods inherited from class java.lang.Object

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

Field Details

mappers

protected List<GuiSwingMapperSet.Mapper> mappers

reprDefaultSet

protected static GuiReprSet reprDefaultSet

defaultMapperSet

protected static GuiSwingMapperSet defaultMapperSet

Constructor Details

GuiSwingMapperSet

public GuiSwingMapperSet()

Method Details

addReprClass

public GuiSwingMapperSet addReprClass(Class<? extends GuiRepresentation> reprClass,
 GuiSwingElement view)

register a mapping of reprClass and a regular view with the type GuiSwingMapperSet.MapperMatchTypeDefault.View

Parameters:

reprClass - a representation class

view - a view factory

Returns:

this

addReprClassTableColumn

public GuiSwingMapperSet addReprClassTableColumn(Class<? extends GuiRepresentation> reprClass,
 GuiSwingElement view)

register a mapping of reprClass and a column view with the type GuiSwingMapperSet.MapperMatchTypeDefault.TableColumn

Parameters:

reprClass - a representation class

view - a column view factory

Returns:

this

addReprClassToTop

public GuiSwingMapperSet addReprClassToTop(Class<? extends GuiRepresentation> reprClass,
 GuiSwingElement view)

register a mapping of reprClass and a regular view with the type GuiSwingMapperSet.MapperMatchTypeDefault.View as top-precedence

Parameters:

reprClass - a representation class

view - a view factory

Returns:

this

Since:

1.6

addReprClassTableColumnToTop

public GuiSwingMapperSet addReprClassTableColumnToTop(Class<? extends GuiRepresentation> reprClass,
 GuiSwingElement view)

register a mapping of reprClass and a column view with the type GuiSwingMapperSet.MapperMatchTypeDefault.TableColumn as top-precedence

Parameters:

reprClass - a representation class

view - a column view factory

Returns:

this

Since:

1.6

add

public GuiSwingMapperSet add(GuiSwingMapperSet.Mapper... mappers)

getMappers

public List<GuiSwingMapperSet.Mapper> getMappers()

view

public GuiSwingElement view(GuiMappingContext context)

Parameters:

context - the target context

Returns:

view as a regular component factory

viewTableColumn

public GuiSwingElement viewTableColumn(GuiMappingContext context)

Parameters:

context - the target context

Returns:

a GuiSwingTableColumn, a GuiSwingTableColumnSet or a GuiSwingAction

view

public GuiSwingElement view(GuiMappingContext context,
 GuiSwingMapperSet.MapperMatchType matchType)

getReprDefaultSet

public static GuiReprSet getReprDefaultSet()

Returns:

the default set of representation including swing-based items. setup by addDefaultReprSetTo(GuiReprSet)

getDefaultMapperSet

public static GuiSwingMapperSet getDefaultMapperSet()

addDefaultReprSetTo

public static void addDefaultReprSetTo(GuiReprSet reprSet)

provide a default set of representations. GuiRepresentation.getDefaultSet() + reprs in autogui.swing.mapping.*

1. GuiReprCollectionElement : precedes GuiReprCollectionTable
2. GuiReprValueBooleanCheckBox
3. GuiReprValueEnumComboBox
4. GuiReprValueFilePathField
5. GuiReprValueNumberSpinner
6. GuiReprValueStringField
7. GuiReprEmbeddedComponent
8. GuiReprValueDocumentEditor
9. GuiReprValueImagePane
10. GuiReprCollectionTable
11. GuiReprObjectTabbedPane : precedes GuiReprObjectPane
12. GuiReprObjectPane
13. GuiReprPropertyPane : follows other property supported panes like GuiReprValueBooleanCheckBox
14. GuiReprAction
15. GuiReprActionList
16. GuiReprValueLabel : matches any type of representations

Parameters:

reprSet - a target set for adding

createEmbeddedComponent

public static GuiReprEmbeddedComponent createEmbeddedComponent()

createValueDocumentEditor

public static GuiReprValueDocumentEditor createValueDocumentEditor()

createValueImagePane

public static GuiReprValueImagePane createValueImagePane(boolean processGlobal)

addDefaultReprClassesTo

public static void addDefaultReprClassesTo(GuiSwingMapperSet viewSet)

provide a default set of mappings between a representation and a view.

mappings for table columns

representation	column view
GuiReprValueBooleanCheckBox	GuiSwingTableColumnBoolean
GuiReprValueStringField	GuiSwingTableColumnString
GuiReprValueEnumComboBox	GuiSwingTableColumnEnum
GuiReprValueFilePathField	GuiSwingTableColumnFilePath
GuiReprValueNumberSpinner	GuiSwingTableColumnNumber
GuiReprValueImagePane	GuiSwingTableColumnImage
GuiReprObjectPane	GuiSwingTableColumnSetDefault
GuiReprCollectionElement	GuiSwingTableColumnSetDefault
GuiReprCollectionTable	GuiSwingTableColumnCollection
GuiReprPropertyPane	GuiSwingTableColumnCollection.GuiSwingTableColumnProperty
GuiReprValue	GuiSwingTableColumnLabel
GuiReprAction	GuiSwingActionDefault

mappings for values

representation	view
GuiReprActionList	null (handled by a sibling GuiSwingViewCollectionTable)
GuiReprValueBooleanCheckBox	GuiSwingViewBooleanCheckBox
GuiReprEmbeddedComponent	GuiSwingViewEmbeddedComponent
GuiReprValueDocumentEditor	GuiSwingViewDocumentEditor
GuiReprValueEnumComboBox	GuiSwingViewEnumComboBox
GuiReprValueFilePathField	GuiSwingViewFilePathField
GuiReprValueImagePane	GuiSwingViewImagePane
GuiReprValueNumberSpinner	GuiSwingViewNumberSpinner
GuiReprValueStringField	GuiSwingViewStringField
GuiReprCollectionTable	GuiSwingViewCollectionTable
GuiReprPropertyPane	GuiSwingViewPropertyPane
GuiReprObjectTabbedPane	GuiSwingViewTabbedPane
GuiReprObjectPane	GuiSwingViewObjectPane
GuiReprAction	GuiSwingActionDefault
GuiReprValue	GuiSwingViewLabel

Parameters:

viewSet - a target set for adding