Package net.sf.jguiraffe.gui.app
Klasse ApplicationBuilderData
java.lang.Object
net.sf.jguiraffe.gui.app.ApplicationBuilderData
- Alle implementierten Schnittstellen:
BuilderData
The application specific default implementation of the BuilderData
interface.
This class provides meaningful implementations of all methods required by the
BuilderData
interface. An instance can be obtained from the
ApplicationContext
class that is already initialized with predefined
values for many fields. So a client need not bother with all of the data
supported by this interface, but has only to set the values it is specially
interested in.
Implementation note: this class is not thread-safe. The typical usage
scenario is that an instance is requested from ApplicationContext
,
initialized with the properties required by the application and passed to a
builder.
- Version:
- $Id: ApplicationBuilderData.java 205 2012-01-29 18:29:57Z oheger $
- Autor:
- Oliver Heger
- Siehe auch:
-
Feldübersicht
Von Schnittstelle geerbte Felder net.sf.jguiraffe.gui.builder.BuilderData
KEY_RESULT_WINDOW
-
Konstruktorübersicht
Konstruktoren -
Methodenübersicht
Modifizierer und TypMethodeBeschreibungvoid
Adds the specifiedBeanCreationListener
to this object.void
addBeanCreationListeners
(Collection<? extends BeanCreationListener> listeners) Adds allBeanCreationListener
objects contained in the given collection to this object.void
addProperty
(String key, Object value) Adds an additional property for the builder operation.Returns the action store.Returns the result object from the bean builder.Returns a collection withBeanCreationListener
objects to be registered at theBeanContext
created by the builder.Returns theBindingStrategy
used by the current form.Returns a reference to theBuilder
instance that processed this object.Returns the bean context used by the builder.Returns the name of the builder.Returns theCommandQueue
.Returns the default resource group.Returns the form bean.Returns theFormValidator
for validating the current form.Returns theInvocationHelper
.Returns theMessageOutput
object.Returns the parent bean context.Returns the parent window.Returns a map with additional properties for the builder operation.Returns the root store populated by the builder.Returns the transformer context.boolean
Returns the auto release flag.boolean
Returns the menu icon flag.boolean
Returns the toolbar text flag.void
setActionStore
(ActionStore actionStore) Sets the action store.void
setAutoRelease
(boolean autoRelease) Sets the auto release flag.void
Sets the result object for the bean builder.void
Sets theBindingStrategy
to be used by the current form.void
setBuilder
(Builder builder) Sets theBuilder
that processed this object.void
Sets the bean context used by the builder.void
setBuilderName
(String builderName) Sets a name for the builder.void
setCommandQueue
(CommandQueue commandQueue) Sets theCommandQueue
.void
setDefaultResourceGroup
(Object defaultResourceGroup) Sets the default resource group.void
setFormBean
(Object formBean) Sets the form bean.void
setFormValidator
(FormValidator validator) Sets theFormValidator
for validating the current form.void
setInvocationHelper
(InvocationHelper invocationHelper) Sets theInvocationHelper
.void
setMenuIcon
(boolean menuIcon) Sets the menu icon flag.void
setMessageOutput
(MessageOutput messageOutput) Sets theMessageOutput
object.void
Sets the parent bean context.void
setParentWindow
(Window parentWindow) Sets the parent window.void
setProperties
(Map<String, Object> props) Sets additional properties for the builder operation.void
setToolbarText
(boolean toolbarText) Sets the toolbar text flag.void
setTransformerContext
(TransformerContext transformerContext) Sets the transformer context.
-
Konstruktordetails
-
ApplicationBuilderData
public ApplicationBuilderData()Creates a new instance ofApplicationBuilderData
.
-
-
Methodendetails
-
getActionStore
Returns the action store.- Angegeben von:
getActionStore
in SchnittstelleBuilderData
- Gibt zurück:
- the action store
-
setActionStore
Sets the action store.- Parameter:
actionStore
- the actionStore
-
getDefaultResourceGroup
Returns the default resource group.- Angegeben von:
getDefaultResourceGroup
in SchnittstelleBuilderData
- Gibt zurück:
- the default resource group
-
setDefaultResourceGroup
Sets the default resource group.- Parameter:
defaultResourceGroup
- the default resource group
-
getFormBean
Returns the form bean.- Angegeben von:
getFormBean
in SchnittstelleBuilderData
- Gibt zurück:
- the form bean
-
setFormBean
Sets the form bean.- Parameter:
formBean
- the form bean
-
getBindingStrategy
Returns theBindingStrategy
used by the current form.- Angegeben von:
getBindingStrategy
in SchnittstelleBuilderData
- Gibt zurück:
- the
BindingStrategy
- Siehe auch:
-
setBindingStrategy
Sets theBindingStrategy
to be used by the current form.- Parameter:
strat
- theBindingStrategy
-
getFormValidator
Returns theFormValidator
for validating the current form.- Angegeben von:
getFormValidator
in SchnittstelleBuilderData
- Gibt zurück:
- the
FormValidator
-
setFormValidator
Sets theFormValidator
for validating the current form. If noFormValidator
is set, no form-level validation is performed. The form's fields may be validated though if corresponding validators have been defined.- Parameter:
validator
- theFormValidator
-
isMenuIcon
public boolean isMenuIcon()Returns the menu icon flag.- Angegeben von:
isMenuIcon
in SchnittstelleBuilderData
- Gibt zurück:
- the menu icon flag
-
setMenuIcon
public void setMenuIcon(boolean menuIcon) Sets the menu icon flag.- Parameter:
menuIcon
- the flag value
-
getParentWindow
Returns the parent window.- Angegeben von:
getParentWindow
in SchnittstelleBuilderData
- Gibt zurück:
- the parent window
-
setParentWindow
Sets the parent window.- Parameter:
parentWindow
- the parent window
-
isToolbarText
public boolean isToolbarText()Returns the toolbar text flag.- Angegeben von:
isToolbarText
in SchnittstelleBuilderData
- Gibt zurück:
- the toolbar text flag
-
setToolbarText
public void setToolbarText(boolean toolbarText) Sets the toolbar text flag.- Parameter:
toolbarText
- the toolbar text flag
-
getTransformerContext
Returns the transformer context.- Angegeben von:
getTransformerContext
in SchnittstelleBuilderData
- Gibt zurück:
- the transformer context
-
setTransformerContext
Sets the transformer context.- Parameter:
transformerContext
- the transformer context
-
getBeanBuilderResult
Returns the result object from the bean builder.- Angegeben von:
getBeanBuilderResult
in SchnittstelleBuilderData
- Gibt zurück:
- the results of the bean builder
-
setBeanBuilderResult
Sets the result object for the bean builder.- Angegeben von:
setBeanBuilderResult
in SchnittstelleBuilderData
- Parameter:
res
- the results of the bean builder
-
getParentContext
Returns the parent bean context.- Angegeben von:
getParentContext
in SchnittstelleBuilderData
- Gibt zurück:
- the parent bean context
-
setParentContext
Sets the parent bean context.- Parameter:
ctx
- the parent bean context
-
getRootStore
Returns the root store populated by the builder. This method can only be called after the builder operation.- Angegeben von:
getRootStore
in SchnittstelleBuilderData
- Gibt zurück:
- the root store returned from the builder
- Löst aus:
IllegalStateException
- if no builder results are available yet- Siehe auch:
-
getBuilderContext
Returns the bean context used by the builder.- Angegeben von:
getBuilderContext
in SchnittstelleBuilderData
- Gibt zurück:
- the builder's bean context
-
setBuilderContext
Sets the bean context used by the builder.- Angegeben von:
setBuilderContext
in SchnittstelleBuilderData
- Parameter:
ctx
- the builder's bean context
-
getInvocationHelper
Returns theInvocationHelper
.- Angegeben von:
getInvocationHelper
in SchnittstelleBuilderData
- Gibt zurück:
- the
InvocationHelper
-
setInvocationHelper
Sets theInvocationHelper
.- Parameter:
invocationHelper
- theInvocationHelper
-
getMessageOutput
Returns theMessageOutput
object.- Angegeben von:
getMessageOutput
in SchnittstelleBuilderData
- Gibt zurück:
- the message output object
-
setMessageOutput
Sets theMessageOutput
object.- Parameter:
messageOutput
- the message output object
-
getCommandQueue
Returns theCommandQueue
.- Angegeben von:
getCommandQueue
in SchnittstelleBuilderData
- Gibt zurück:
- the command queue
-
setCommandQueue
Sets theCommandQueue
.- Parameter:
commandQueue
- the command queue
-
getBeanCreationListeners
Returns a collection withBeanCreationListener
objects to be registered at theBeanContext
created by the builder. Note: this collection cannot be modified.- Angegeben von:
getBeanCreationListeners
in SchnittstelleBuilderData
- Gibt zurück:
- a collection with
BeanCreationListener
objects
-
addBeanCreationListener
Adds the specifiedBeanCreationListener
to this object. It will be registered at theBeanContext
created by the builder and thus notified for all bean created by the dependency injection framework.- Parameter:
l
- theBeanCreationListener
to be added (must not be null)- Löst aus:
IllegalArgumentException
- if theBeanCreationListener
is null
-
addBeanCreationListeners
Adds allBeanCreationListener
objects contained in the given collection to this object. They will be registered at theBeanContext
created by the builder and thus notified for all bean created by the dependency injection framework.- Parameter:
listeners
- the collection withBeanCreationListener
objects (must not be null)- Löst aus:
IllegalArgumentException
- if the collection is null or contains null elements
-
getBuilder
Returns a reference to theBuilder
instance that processed this object. This value is available only after theBuilder
was called.- Angegeben von:
getBuilder
in SchnittstelleBuilderData
- Gibt zurück:
- the
Builder
that processed thisBuilderData
object
-
setBuilder
Sets theBuilder
that processed this object. This method is called by theBuilder
instance during the builder operation.- Angegeben von:
setBuilder
in SchnittstelleBuilderData
- Parameter:
builder
- theBuilder
-
getBuilderName
Returns the name of the builder.- Angegeben von:
getBuilderName
in SchnittstelleBuilderData
- Gibt zurück:
- the name of the builder
-
setBuilderName
Sets a name for the builder. This name is available during the build process (through theComponentBuilderData
object). It can be used for conditional execution of builder scripts.- Parameter:
builderName
- the name of the builder
-
isAutoRelease
public boolean isAutoRelease()Returns the auto release flag.- Angegeben von:
isAutoRelease
in SchnittstelleBuilderData
- Gibt zurück:
- the auto release flag
-
setAutoRelease
public void setAutoRelease(boolean autoRelease) Sets the auto release flag. This flag is evaluated if a window is generated during the builder operation. A value of true means that this object and all resources referenced by it should be freed automatically when the window is closed. This is done by invokingBuilder.release(BuilderData)
on theBuilder
responsible. Note that the default value of this flag is true, so auto release is enabled per default.- Parameter:
autoRelease
- the value of the auto release flag
-
getProperties
Returns a map with additional properties for the builder operation. This implementation either returns the map set bysetProperties(Map)
or the one that was created automatically whenUngültige Referenz
#addProperty()
- Angegeben von:
getProperties
in SchnittstelleBuilderData
- Gibt zurück:
- a map with additional properties for the builder operation
- Siehe auch:
-
setProperties
Sets additional properties for the builder operation. The map passed to this method is directly stored and passed to the builder.- Parameter:
props
- the map with additional properties
-
addProperty
Adds an additional property for the builder operation. This method can be used to populate the map with additional properties that is returned bygetProperties()
. If no map with properties has been set yet, a new one is created (getProperties()
will return this new map). Otherwise, the property is added to the existing map.- Parameter:
key
- the key of the propertyvalue
- the value of the property
-