Package org.apache.wicket.feedback
Class FeedbackCollector
java.lang.Object
org.apache.wicket.feedback.FeedbackCollector
Collects feedback messages from all the places where they can be stored.
- Author:
- igor
-
Constructor Summary
ConstructorDescriptionConstructs a collector that will only collect messages fromSession
.FeedbackCollector
(Component component) Constructs a collector that will collect messages from the specifiedcontainer
FeedbackCollector
(Component component, boolean includeSession) Constructs a collector that will collect messages fromSession
and specifiedcontainer
-
Method Summary
Modifier and TypeMethodDescriptionfinal List<FeedbackMessage>
collect()
Collects all feedback messagesfinal List<FeedbackMessage>
collect
(IFeedbackMessageFilter filter) Collects all feedback messages that match the specifiedfilter
final FeedbackCollector
setIncludeSession
(boolean value) Controls whether or not feedback from theSession
will be collected SeeSession.getFeedbackMessages()
final FeedbackCollector
setRecursive
(boolean value) Controls whether or not feedback will be collected recursively from the descendants of the specified component.protected boolean
shouldRecurseInto
(Component component) Determines whether or not recursive message collection should continue into the specified component.
-
Constructor Details
-
FeedbackCollector
public FeedbackCollector()Constructs a collector that will only collect messages fromSession
. To collect messages from session and components useFeedbackCollector(Component, boolean)
. -
FeedbackCollector
Constructs a collector that will collect messages from the specifiedcontainer
- Parameters:
component
- root component from which feedback will be collected
-
FeedbackCollector
Constructs a collector that will collect messages fromSession
and specifiedcontainer
- Parameters:
component
- root component from which feedback will be collectedincludeSession
- controls whether or not feedback from theSession
will be collected
-
-
Method Details
-
setIncludeSession
Controls whether or not feedback from theSession
will be collected SeeSession.getFeedbackMessages()
- Parameters:
value
-- Returns:
this
for chaining
-
setRecursive
Controls whether or not feedback will be collected recursively from the descendants of the specified component.- Parameters:
value
-- Returns:
this
for chaining
-
collect
Collects all feedback messages- Returns:
- a
List
of collected messages
-
collect
Collects all feedback messages that match the specifiedfilter
- Parameters:
filter
-- Returns:
- a
List
of collected messages
-
shouldRecurseInto
Determines whether or not recursive message collection should continue into the specified component. If returningfalse
feedback messages from the specified component nor any of its children will be included.- Parameters:
component
-- Returns:
-