Package ch.tocco.nice2.model.form.impl.reader.handlers

Class ActionComponentHandler

java.lang.Object

ch.tocco.nice2.model.form.spi.reader.handler.AbstractComponentHandler<Action>

ch.tocco.nice2.model.form.impl.reader.handlers.ActionComponentHandler

public class ActionComponentHandler
extends AbstractComponentHandler<Action>

Field Summary

Fields inherited from class ch.tocco.nice2.model.form.spi.reader.handler.AbstractComponentHandler

displayType, field, forceEditable, label, name, receiver, scopes, useLabel

Constructor Summary

Constructors

Constructor	Description
ActionComponentHandler(ComponentReceiver receiver)

Method Summary

Modifier and Type	Method	Description
void	actionType(String actionType)
PropertyTagHandler	addProps()
void	afterFinish()	Will be called after running the AbstractComponentHandler.finish()-Method.
void	appId(String appId)
void	beforeFinish()	Will be called before running the AbstractComponentHandler.finish()-Method this.field won't be available yet.
void	buttonStyle(String buttonStyle)
void	buttonType(String buttonType)
void	conditionName(String conditionName)
void	confirmationThreshold(int confirmationThreshold)
void	defaultAction(String defaultAction)
void	dmsEntityModel(String buttonType)
protected void	doFinish()	Assembles the component together.
void	endpoint(String endpoint)
void	fullscreen(boolean fullscreen)
protected Class<? extends Action>	getImplClass()	A concrete class which implments AbstractComponentHandler (not the handler).
protected Class<Action>	getInterface()	Return the Interface which represents this component (not the handler).
void	maxSelection(int maxSelection)
void	minSelection(int minSelection)
void	runInBackground(boolean runInBackground)
void	setExtIcon(@Nullable String icon)
void	setGroup(String group)
void	setIcon(@Nullable String icon)
final void	setOnlyShowOnEmptyColumn(boolean hide)
void	setPath(String path)
void	setReactIcon(@Nullable String icon)
void	setType(@Nullable String type)
void	showConfirmation(boolean showConfirmation)
Object	tag(String tagName)	We don't care about sub-elements so we let the ComponentHandlerContextFactory do it.

Methods inherited from class ch.tocco.nice2.model.form.spi.reader.handler.AbstractComponentHandler

addAttributeProps, addExtProps, createOrGetComponent, disableOldClient, finish, forceEditable, label, setDisplayType, setLabel, setName, setPosition, setScopes, setUseLabel, startElement

Methods inherited from class java.lang.Object

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

Constructor Details

ActionComponentHandler

public ActionComponentHandler(ComponentReceiver receiver)

Method Details

setPath

@Attribute("path")
public void setPath(String path)

setType

@Attribute("type")
public void setType(@Nullable
 @Nullable String type)

setIcon

@Attribute("icon")
public void setIcon(@Nullable
 @Nullable String icon)

setExtIcon

@Attribute("ext-icon")
public void setExtIcon(@Nullable
 @Nullable String icon)

setReactIcon

@Attribute("react-icon")
public void setReactIcon(@Nullable
 @Nullable String icon)

setGroup

@Attribute("group")
public void setGroup(String group)

endpoint

@Attribute("endpoint")
public void endpoint(String endpoint)

buttonType

@Attribute("button-type")
public void buttonType(String buttonType)

dmsEntityModel

@Attribute("dms-entity-model")
public void dmsEntityModel(String buttonType)

appId

@Attribute("appId")
public void appId(String appId)

minSelection

@Attribute("minSelection")
public void minSelection(int minSelection)

maxSelection

@Attribute("maxSelection")
public void maxSelection(int maxSelection)

showConfirmation

@Attribute("showConfirmation")
public void showConfirmation(boolean showConfirmation)

confirmationThreshold

@Attribute("confirmationThreshold")
public void confirmationThreshold(int confirmationThreshold)

runInBackground

@Attribute("runInBackground")
public void runInBackground(boolean runInBackground)

fullscreen

@Attribute("fullscreen")
public void fullscreen(boolean fullscreen)

defaultAction

@Attribute("default")
public void defaultAction(String defaultAction)

actionType

@Attribute("action-type")
public void actionType(String actionType)

setOnlyShowOnEmptyColumn

@Attribute("only-show-on-empty-column")
public final void setOnlyShowOnEmptyColumn(boolean hide)

conditionName

@Attribute("condition-name")
public void conditionName(String conditionName)

buttonStyle

@Attribute("button-style")
public void buttonStyle(String buttonStyle)

addProps

@Element("properties")
@Cardinality(min=0,
             max=1)
public PropertyTagHandler addProps()
                            throws ModelBuildException

Throws:

ModelBuildException

getImplClass

protected Class<? extends Action> getImplClass()

Description copied from class: AbstractComponentHandler

A concrete class which implments AbstractComponentHandler (not the handler). Expects a public-constructor which takes the parent Compononent.

Specified by:

getImplClass in class AbstractComponentHandler<Action>

Returns:

the class

beforeFinish

public void beforeFinish()

Description copied from class: AbstractComponentHandler

Will be called before running the AbstractComponentHandler.finish()-Method this.field won't be available yet.

Overrides:

beforeFinish in class AbstractComponentHandler<Action>

See Also:

• AbstractComponentHandler.afterFinish()

doFinish

protected void doFinish()
                 throws ModelBuildException

Description copied from class: AbstractComponentHandler

Assembles the component together.

Overrides:

doFinish in class AbstractComponentHandler<Action>

Throws:

ModelBuildException - =(

afterFinish

public void afterFinish()

Description copied from class: AbstractComponentHandler

Will be called after running the AbstractComponentHandler.finish()-Method. this.field will be ready to fill.

Overrides:

afterFinish in class AbstractComponentHandler<Action>

See Also:

• AbstractComponentHandler.beforeFinish()

getInterface

protected Class<Action> getInterface()

Description copied from class: AbstractComponentHandler

Return the Interface which represents this component (not the handler). This interface is normally AbstractComponentHandler

Specified by:

getInterface in class AbstractComponentHandler<Action>

Returns:

interface-class

tag

@AnyElement
@Cardinality(min=0,
             max=2147483647)
public Object tag(@ElementName
 String tagName)
           throws ModelBuildException

We don't care about sub-elements so we let the ComponentHandlerContextFactory do it.

Parameters:

tagName - the tag

Returns:

a component

Throws:

ModelBuildException - in case any of the sub-components had an error