GrepCode: org.apache.wicket.behavior.IBehavior (.java) - Interface

Maven-Central
/
org.apache.wicket / wicket
/
1.3.6

1.5-M3
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.7
1.3.6
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc2
1.3.0-beta2
/
org.apache.wicket.behavior.IBehavior
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * Licensed to the Apache Software Foundation (ASF) under one or more
3
   * contributor license agreements.  See the NOTICE file distributed with
4
   * this work for additional information regarding copyright ownership.
5
   * The ASF licenses this file to You under the Apache License, Version 2.0
6
   * (the "License"); you may not use this file except in compliance with
7
   * the License.  You may obtain a copy of the License at
8
   *
9
   *      http://www.apache.org/licenses/LICENSE-2.0
10
  *
11
  * Unless required by applicable law or agreed to in writing, software
12
  * distributed under the License is distributed on an "AS IS" BASIS,
13
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
  * See the License for the specific language governing permissions and
15
  * limitations under the License.
16
  */
17
 package org.apache.wicket.behavior;
18
 
19
 import org.apache.wicket.Component;
20
 import org.apache.wicket.IClusterable;
21
 import org.apache.wicket.markup.ComponentTag;

 Behaviors are kind of plug-ins for Components. They allow to be added to a component and get
 essential events forwarded by the component. they can be bound to a concrete component (using the
 bind method is called when the behavior is attached), but they don't need to. They can modify the
 components markup by changing the rendered ComponentTag. Behaviors can have their own models as
 well, and they are notified when these are to be detached by the component.
 
 It is recommended that you extend from AbstractBehavior
 instead of directly implementing this interface.
 
 Author(s):Ralf EbertEelco HilleniusIgor Vaynberg (ivaynberg) See also:IBehaviorListenerorg.apache.wicket.markup.html.IHeaderContributorAbstractAjaxBehaviororg.apache.wicket.AttributeModifier
42
 
43
 public interface IBehavior extends IClusterable
44
 {
	
 Called when a component is about to render.
 
 
 Parameters:component
            the component that has this behavior coupled
50
 
51
 	void beforeRender(Component component);

	
 Called when a component that has this behavior coupled was rendered.
 
 
 Parameters:component
            the component that has this behavior coupled
58
 
59
 	void afterRender(Component component);

	
 Bind this handler to the given component. This method is called by the host component
 immediately after this behavior is added to it. This method is useful if you need to do
 initialization based on the component it is attached and you can't wait to do it at render
 time. Keep in mind that if you decide to keep a reference to the host component, it is not
 thread safe anymore, and should thus only be used in situations where you do not reuse the
 behavior for multiple components.
 
 
 Parameters:component
            the component to bind to
71
 
72
 	void bind(Component component);

	
 Allows the behavior to detach any state it has attached during request processing.
 
 
 Parameters:component
            the component that initiates the detachment of this behavior
79
 
80
 	void detach(Component component);

	
 In case an unexpected exception happened anywhere between onComponentTag() and rendered(),
 onException() will be called for any behavior. Typically, if you clean up resources in
 afterRender(org.apache.wicket.Component), you should do the same in the implementation of this
 method.
 
 
 Parameters:component
            the component that has a reference to this behavior and during which processing
            the exception occurredexception
            the unexpected exception
93
 
94
 	void exception(Component component, RuntimeException exception);

	
 This method returns false if the behavior generates a callback url (for example ajax
 behaviors)
 
 
 Parameters:component
            the component that has this behavior coupled. Returns:boolean true or false.
104
105
	boolean getStatelessHint(Component component);

	
 Called when a components is rendering and wants to render this behavior. If false is returned
 this behavior will be ignored.
 
 
 Parameters:component
            the component that has this behavior coupled Returns:true if this behavior must be executed/rendered
115
116
	boolean isEnabled(Component component);

	
 Called any time a component that has this behavior registered is rendering the component tag.
 
 
 Parameters:component
            the component that renders this tag currentlytag
            the tag that is rendered
125
126
	void onComponentTag(Component component, ComponentTag tag);

	
 Specifies whether or not this behavior is temporary. Temporary behaviors are removed at the
 end of request. Such behaviors are useful for modifying component rendering only when it
 renders next. Usecases include javascript effects, initial clientside dom setup, etc.
 
 
 Returns:true if this behavior is temporary
134
135
	boolean isTemporary();
136
}