com.uwyn.rife.engine.annotations
Annotation Type FlowlinkExitField


@Retention(value=RUNTIME)
@Target(value=FIELD)
@Documented
public @interface FlowlinkExitField

Declares a flow link for the element. This annotation may only be used on final String fields. The value of the field is used as the source exit name.

Since:
1.5
Version:
$Revision: 3634 $
Author:
Steven Grimm (koreth[remove] at midwinter dot com), Geert Bevin (gbevin[remove] at uwyn dot com)
See Also:
Flowlink

Optional Element Summary
 Datalink[] datalinks
          This flow link's data links.
 Class destClass
          The Java class of the destination element for this data link.
 String destClassIdPrefix
          The prefix that will be added to the destClass ID.
 String destId
          The ID of the destination element for this flow link.
 FlowlinkExitField.Embedding embedding
          Indicates whether element embedded should be preserved or cancelled when this flow link is followed.
 FlowlinkExitField.Inheritance inheritance
          Indicates whether the behavioral inheritance (3D flow) should be preserved or cancelled when this flow link is followed.
 boolean redirect
          Indicates whether this flow link will redirect to a dedicated URL instead of executing the destination element directly.
 boolean snapback
          Indicates whether this flow link is a snapback.
 

destId

public abstract String destId
The ID of the destination element for this flow link.

If destClass is provided, it will override the destId value.

Since:
1.5
See Also:
destClass()
Default:
""

destClass

public abstract Class destClass
The Java class of the destination element for this data link. This class should at least have an Elem annotation.

If destClass is provided, it will override the destId value.

The ID will be evaluated locally to the current subsite. If you have to refer to an ID in another subsite, you have to use the destClassIdPrefix().

Since:
1.5
See Also:
destId(), destClassIdPrefix()
Default:
void.class

destClassIdPrefix

public abstract String destClassIdPrefix
The prefix that will be added to the destClass ID.

This makes it possible to refer to an ID in another subsite. Note that this prefix is not validated individually, it is merely added as a string to build the final ID that will be used.

Since:
1.5
See Also:
destClass()
Default:
""

snapback

public abstract boolean snapback
Indicates whether this flow link is a snapback.

Since:
1.5
Default:
false

redirect

public abstract boolean redirect
Indicates whether this flow link will redirect to a dedicated URL instead of executing the destination element directly.

Since:
1.5
Default:
false

inheritance

public abstract FlowlinkExitField.Inheritance inheritance
Indicates whether the behavioral inheritance (3D flow) should be preserved or cancelled when this flow link is followed.

Since:
1.5
Default:
com.uwyn.rife.engine.annotations.FlowlinkExitField.Inheritance.PRESERVE

embedding

public abstract FlowlinkExitField.Embedding embedding
Indicates whether element embedded should be preserved or cancelled when this flow link is followed.

Since:
1.5
Default:
com.uwyn.rife.engine.annotations.FlowlinkExitField.Embedding.PRESERVE

datalinks

public abstract Datalink[] datalinks
This flow link's data links.

Since:
1.5
Default:
{}


Copyright © 2001-2007 Uwyn sprl/bvba. All Rights Reserved.