public class EventConstants extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACTION
Default client event name, "action", used in most situations.
|
static java.lang.String |
ACTIVATE
Event triggered when a page is activated (for rendering).
|
static java.lang.String |
ADD_ROW
Event triggered by
AjaxFormLoop to inform the
container that a new row has been requested. |
static java.lang.String |
CANCELED
Event triggered when a client-side form is canceled.
|
static java.lang.String |
DECORATE_COMPONENT_EVENT_LINK
Event triggered during component event link generation.
|
static java.lang.String |
DECORATE_PAGE_RENDER_LINK
Event triggered during page render link generation.
|
static java.lang.String |
FAILURE
Event type for a notification after the form has been submitted, when there are errors in the
validation tracker.
|
static java.lang.String |
NODE_SELECTED
Event triggered by the
Tree
component when a leaf node is selected. |
static java.lang.String |
NODE_UNSELECTED
Event triggered by the
Tree
component when a leaf node is unselected. |
static java.lang.String |
PARSE_CLIENT
Event triggered by some form-related components to parse a value provided by the client.
|
static java.lang.String |
PASSIVATE
Event triggered when a link for a page is generated.
|
static java.lang.String |
PREALLOCATE_FORM_CONTROL_NAMES
Name of a event triggered by the form component on the active page
to allow it to pre-allocate the names of any query parameters that might be used by the page for its own purposes
and should not be allocated to components.
|
static java.lang.String |
PREPARE
Invoked to let the containing component(s) prepare for the form rendering or the form
submission.
|
static java.lang.String |
PREPARE_FOR_RENDER
Invoked before
PREPARE when rendering out the form. |
static java.lang.String |
PREPARE_FOR_SUBMIT
Invoked before
PREPARE when the form is submitted. |
static java.lang.String |
PROGRESSIVE_DISPLAY
Event triggered by
ProgressiveDisplay component to inform its
container of what context (if any) is available. |
static java.lang.String |
PROVIDE_COMPLETIONS
Event triggered by an
Autocomplete mixin to
request completions of
the current input. |
static java.lang.String |
REFRESH
Event triggered by
ZoneRefresh to refresh the
Zone |
static java.lang.String |
REMOVE_ROW
Event triggered by
AjaxFormLoop to inform the
container about the
row removed on the client side. |
static java.lang.String |
SELECTED
Event type triggered by the
Submit component
when it is the cause
of the form submission. |
static java.lang.String |
SUBMIT
Event type for a notification after the form has submitted.
|
static java.lang.String |
SUCCESS
Event type for a notification after the form has submitted, when there are no errors in the
validation tracker.
|
static java.lang.String |
SYNCHRONIZE_VALUES
Event triggered by the
Loop component to
inform its container of
all the values that were supplied from the client during a form submission. |
static java.lang.String |
TO_CLIENT
Event triggered by some form-related components to convert a server-side value to a
client-side string, as an
alternative to a
Translator . |
static java.lang.String |
VALIDATE
Event triggered by form-related components to validate user input.
|
static java.lang.String |
VALUE_CHANGED
Event triggered by
Select component to inform
its
container that Select's value has changed. |
Constructor and Description |
---|
EventConstants() |
public static final java.lang.String ACTION
public static final java.lang.String ACTIVATE
public static final java.lang.String PASSIVATE
public static final java.lang.String PREPARE_FOR_RENDER
PREPARE
when rendering out the form.Form
,
Constant Field Valuespublic static final java.lang.String PREPARE_FOR_SUBMIT
PREPARE
when the form is submitted.Form
,
Constant Field Valuespublic static final java.lang.String PREPARE
Form
,
Constant Field Valuespublic static final java.lang.String SUBMIT
Form
,
Constant Field Valuespublic static final java.lang.String CANCELED
ComponentAction
s for the form are triggered.SubmitMode.CANCEL
,
Constant Field Valuespublic static final java.lang.String SUCCESS
SUBMIT
event.Form
,
Constant Field Valuespublic static final java.lang.String FAILURE
SUBMIT
event.public static final java.lang.String SELECTED
Submit
component
when it is the cause
of the form submission.public static final java.lang.String PARSE_CLIENT
Translator
.public static final java.lang.String TO_CLIENT
Translator
.public static final java.lang.String VALIDATE
SUCCESS
or FAILURE
as a chance
to perform cross-form validations.public static final java.lang.String REMOVE_ROW
AjaxFormLoop
to inform the
container about the
row removed on the client side. The event context is the object that was removed.public static final java.lang.String ADD_ROW
AjaxFormLoop
to inform the
container that a new row has been requested. The return value from the event handler must be the newly created
object, which must
also be visible in the AjaxFormLoop.encoder
parameter.public static final java.lang.String SYNCHRONIZE_VALUES
Loop
component to
inform its container of
all the values that were supplied from the client during a form submission. The event handler
method should have
a single parameter, of type Object[] or type List, to receive the values.public static final java.lang.String PROGRESSIVE_DISPLAY
ProgressiveDisplay
component to inform its
container of what context (if any) is available. The event handler may return a renderable
object or null. If
null is returned, the component renders its own body as the partial markup response.public static final java.lang.String PROVIDE_COMPLETIONS
Autocomplete
mixin to
request completions of
the current input. The first value in the context is the input string; additional values
in the context parameter of the Autocomplete
component.public static final java.lang.String VALUE_CHANGED
Select
component to inform
its
container that Select's value has changed.public static final java.lang.String DECORATE_PAGE_RENDER_LINK
Link
object, the
second is the PageRenderRequestParameters
from which the Link
was created. The event is triggered on the actively rendering page.public static final java.lang.String DECORATE_COMPONENT_EVENT_LINK
Link
object,
the second is the ComponentEventRequestParameters
from which the Link
was created. The event is triggered on the actively rendering page, not necessarily the page
containing the component.public static final java.lang.String PREALLOCATE_FORM_CONTROL_NAMES
IdAllocator
is passed as the event context.public static final java.lang.String NODE_SELECTED
Tree
component when a leaf node is selected.public static final java.lang.String NODE_UNSELECTED
Tree
component when a leaf node is unselected.public static final java.lang.String REFRESH
ZoneRefresh
to refresh the
Zone
public EventConstants()
${project.version} - Copyright © 2003-2015 The Apache Software Foundation.