Find Usages Diff Raw Download HTML Widget
Start line:  
End line:  

Snippet Preview

Snippet HTML Code

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;
18
  
23
  import java.util.List;
24
  import java.util.Locale;
25
  
55
  import org.slf4j.Logger;
Component serves as the highest level abstract base class for all components.
  • Identity - All Components must have a non-null id which is retrieved by calling getId(). The id must be unique within the MarkupContainer that holds the Component, but does not have to be globally unique or unique within a Page's component hierarchy.
  • Hierarchy - A component has a parent which can be retrieved with getParent(). If a component is an instance of MarkupContainer, it may have children. In this way it has a place in the hierarchy of components contained on a given page.
  • Component Paths - The path from the Page at the root of the component hierarchy to a given Component is simply the concatenation with dot separators of each id along the way. For example, the path "a.b.c" would refer to the component named "c" inside the MarkupContainer named "b" inside the container named "a". The path to a component can be retrieved by calling getPath(). This path is an absolute path beginning with the id of the Page at the root. Pages bear a PageMap/Session-relative identifier as their id, so each absolute path will begin with a number, such as "0.a.b.c". To get a Component path relative to the page that contains it, you can call getPageRelativePath().
  • LifeCycle - Components participate in the following lifecycle phases:
    • Construction - A Component is constructed with the Java language new operator. Children may be added during construction if the Component is a MarkupContainer.
    • Request Handling - An incoming request is processed by a protocol request handler such as WicketServlet. An associated Application object creates Session, Request and Response objects for use by a given Component in updating its model and rendering a response. These objects are stored inside a container called RequestCycle which is accessible via getRequestCycle(). The convenience methods getRequest(), getResponse() and getSession() provide easy access to the contents of this container.
    • Listener Invocation - If the request references a listener on an existing Component, that listener is called, allowing arbitrary user code to handle events such as link clicks or form submits. Although arbitrary listeners are supported in Wicket, the need to implement a new class of listener is unlikely for a web application and even the need to implement a listener interface directly is highly discouraged. Instead, calls to listeners are routed through logic specific to the event, resulting in calls to user code through other overridable methods. For example, the org.apache.wicket.markup.html.form.IFormSubmitListener.onFormSubmitted() method implemented by the Form class is really a private implementation detail of the Form class that is not designed to be overridden (although unfortunately, it must be public since all interface methods in Java must be public). Instead, Form subclasses should override user-oriented methods such as onValidate(), onSubmit() and onError() (although only the latter two are likely to be overridden in practice).
    • onBeginRequest - The onBeginRequest() method is called.
    • Form Submit - If a Form has been submitted and the Component is a FormComponent, the component's model is validated by a call to FormComponent.validate().
    • Form Model Update - If a valid Form has been submitted and the Component is a FormComponent, the component's model is updated by a call to FormComponent.updateModel().
    • Rendering - A markup response is generated by the Component via render(), which calls subclass implementation code contained in onRender(org.apache.wicket.markup.MarkupStream). Once this phase begins, a Component becomes immutable. Attempts to alter the Component will result in a WicketRuntimeException.
    • onEndRequest () - The onEndRequest() method is called.
  • Component Models - The primary responsibility of a component is to use its model (an object that implements IModel), which can be set via setModel(org.apache.wicket.model.IModel) and retrieved via getModel(), to render a response in an appropriate markup language, such as HTML. In addition, form components know how to update their models based on request information. Since the IModel interface is a wrapper around an actual model object, a convenience method getModelObject() is provided to retrieve the model Object from its IModel wrapper. A further convenience method, getModelObjectAsString(), is provided for the very common operation of converting the wrapped model Object to a String.
  • Visibility - Components which have setVisible(false) will return false from isVisible() and will not render a response (nor will their children).
  • Page - The Page containing any given Component can be retrieved by calling getPage(). If the Component is not attached to a Page, an IllegalStateException will be thrown. An equivalent method, findPage() is available for special circumstances where it might be desirable to get a null reference back instead.
  • Session - The Page for a Component points back to the Session that contains the Page. The Session for a component can be accessed with the convenience method getSession(), which simply calls getPage().getSession().
  • Locale - The Locale for a Component is available through the convenience method getLocale(), which is equivalent to getSession().getLocale().
  • String Resources - Components can have associated String resources via the Application's Localizer, which is available through the method getLocalizer(). The convenience methods getString(java.lang.String) and getString(java.lang.String,org.apache.wicket.model.IModel) wrap the identical methods on the Application Localizer for easy access in Components.
  • Style - The style ("skin") for a component is available through getStyle(), which is equivalent to getSession().getStyle(). Styles are intended to give a particular look to a Component or Resource that is independent of its Locale. For example, a style might be a set of resources, including images and markup files, which gives the design look of "ocean" to the user. If the Session's style is set to "ocean" and these resources are given names suffixed with "_ocean", Wicket's resource management logic will prefer these resources to other resources, such as default resources, which are not as good of a match.
  • Variation - Whereas Styles are Session (user) specific, variations are component specific. E.g. if the Style is "ocean" and the Variation is "NorthSea", than the resources are given the names suffixed with "_ocean_NorthSea".
  • AttributeModifiers - You can add one or more AttributeModifiers to any component if you need to programmatically manipulate attributes of the markup tag to which a Component is attached.
  • Application, ApplicationSettings and ApplicationPages - The getApplication() method provides convenient access to the Application for a Component via getSession().getApplication(). The getApplicationSettings() method is equivalent to getApplication().getSettings(). The getApplicationPages is equivalent to getApplication().getPages().
  • Feedback Messages - The debug(java.lang.String), info(java.lang.String), warn(java.lang.String), error(java.io.Serializable) and fatal(java.lang.String) methods associate feedback messages with a Component. It is generally not necessary to use these methods directly since Wicket validators automatically register feedback messages on Components. Any feedback message for a given Component can be retrieved with getFeedbackMessage().
  • Page Factory - It is possible to change the way that Pages are constructed by overriding the getPageFactory() method, returning your own implementation of IPageFactory.
  • Versioning - Pages are the unit of versioning in Wicket, but fine-grained control of which Components should participate in versioning is possible via the setVersioned(boolean) method. The versioning participation of a given Component can be retrieved with isVersioned().
  • AJAX support- Components can be re-rendered after the whole Page has been rendered at least once by calling doRender().

    Author(s):
    Jonathan Locke
    Chris Turner
    Eelco Hillenius
    Johan Compagner
    Juergen Donnerstag
    Igor Vaynberg (ivaynberg)
200
 
201
 public abstract class Component implements IClusterable, IConverterLocator
202
 {
Change record of a model. 
205
 
206
 	public class ComponentModelChange extends Change
207
 	{
208
 		private static final long serialVersionUID = 1L;
Former model.
210
 
211
 		private final IModel model;
Construct.

Parameters:
model
217
 
218
 		public ComponentModelChange(IModel model)
219
 		{
220
 			super();
221
 			this. = model;
222
 		}

See also:
java.lang.Object.toString()
226
 
227
 		public String toString()
228
 		{
229
 			return "ComponentModelChange[component: " + getPath() + "]";
230
 		}

See also:
org.apache.wicket.version.undo.Change.undo()
234
 
235
 		public void undo()
236
 		{
238
 		}
239
 	}
Generic component visitor interface for component traversals. 
243
 
244
 	public static interface IVisitor
245
 	{
Value to return to continue a traversal. 
248
 
249
 		public static final Object CONTINUE_TRAVERSAL = null;
A generic value to return to continue a traversal, but if the component is a container, don't visit its children. 
254
 
255
 		public static final Object CONTINUE_TRAVERSAL_BUT_DONT_GO_DEEPER = new Object();
A generic value to return to stop a traversal. 
259
 
260
 		public static final Object STOP_TRAVERSAL = new Object();
Called at each component in a traversal.

Parameters:
component The component
Returns:
CONTINUE_TRAVERSAL (null) if the traversal should continue, or a non-null return value for the traversal method if it should stop. If no return value is useful, the generic non-null value STOP_TRAVERSAL can be used.
270
 
271
 		public Object component(Component component);
272
 	}
Change object for undoing addition of behavior

Author(s):
Igor Vaynberg (ivaynberg)
278
 
279
 	private final class AddedBehaviorChange extends Change
280
 	{
281
 
282
 		private static final long serialVersionUID = 1L;
283
 
284
 		private final IBehavior behavior;
Construct.

Parameters:
behavior
290
 
291
 		public AddedBehaviorChange(IBehavior behavior)
292
 		{
293
 			this. = behavior;
294
 		}
295
 
296
 		public String toString()
297
 		{
298
 			return "[" + getClass().getName() + " behavior=" + .toString() + "]";
299
 		}
300
 
301
 		public void undo()
302
 		{
304
 		}
305
 
306
 	}
Undo change for component border property

Author(s):
ivaynberg
312
 
313
 	private class ComponentBorderChange extends Change
314
 	{
315
 		private static final long serialVersionUID = 1L;
316
 
317
 		private final IComponentBorder old = getComponentBorder();
318
 
319
 		public void undo()
320
 		{
322
 		}
323
 
324
 	}
Change object for undoing removal of behavior

Author(s):
Igor Vaynberg (ivaynberg)
330
 
331
 	private final class RemovedBehaviorChange extends Change
332
 	{
333
 
334
 		private static final long serialVersionUID = 1L;
335
 
336
 		private final IBehavior behavior;
Construct.

Parameters:
behavior
342
 
343
 		public RemovedBehaviorChange(IBehavior behavior)
344
 		{
345
 			this. = behavior;
346
 		}
347
 
348
 		public String toString()
349
 		{
350
 			return "[" + getClass().getName() + " behavior=" + .toString() + "]";
351
 		}
352
 
353
 		public void undo()
354
 		{
356
 		}
357
 
358
 	}
A enabled change operation. 
363
 
364
 	protected final static class EnabledChange extends Change
365
 	{
366
 		private static final long serialVersionUID = 1L;
Subject.
368
 
369
 		private final Component component;
Former value.
371
 
372
 		private final boolean enabled;
Construct.

Parameters:
component
378
 
379
 		EnabledChange(final Component component)
380
 		{
381
 			this. = component;
382
 			 = component.getFlag();
383
 		}

See also:
java.lang.Object.toString()
387
 
388
 		public String toString()
389
 		{
390
 			return "EnabledChange[component: " + .getPath() + ",enabled: " +  + "]";
391
 		}

See also:
org.apache.wicket.version.undo.Change.undo()
395
 
396
 		public void undo()
397
 		{
399
 		}
400
 	}
A visibility change operation. 
404
 
405
 	protected final static class VisibilityChange extends Change
406
 	{
407
 		private static final long serialVersionUID = 1L;
Subject.
409
 
410
 		private final Component component;
Former value.
412
 
413
 		private final boolean visible;
Construct.

Parameters:
component
419
 
420
 		VisibilityChange(final Component component)
421
 		{
422
 			this. = component;
423
 			 = component.getFlag();
424
 		}

See also:
java.lang.Object.toString()
428
 
429
 		public String toString()
430
 		{
431
 			return "VisibilityChange[component: " + .getPath() + ", visible: " +  +
432
 				"]";
433
 		}

See also:
org.apache.wicket.version.undo.Change.undo()
437
 
438
 		public void undo()
439
 		{
441
 		}
442
 	}
Action used with IAuthorizationStrategy to determine whether a component is allowed to be enabled.

If enabling is authorized, a component may decide by itself (typically using it's enabled property) whether it is enabled or not. If enabling is not authorized, the given component is marked disabled, regardless its enabled property.

When a component is not allowed to be enabled (in effect disabled through the implementation of this interface), Wicket will try to prevent model updates too. This is not completely fail safe, as constructs like: 

 User u = (User)getModelObject();
 u.setName("got you there!");
can't be prevented. Indeed it can be argued that any model protection is best dealt with in your model objects to be completely secured. Wicket will catch all normal framework-directed use though. 
465
 
466
 	public static final Action ENABLE = new Action(.);
Separator for component paths
468
 
469
 	public static final char PATH_SEPARATOR = ':';
Action used with IAuthorizationStrategy to determine whether a component and its children are allowed to be rendered.

There are two uses for this method:

  • The 'normal' use is for controlling whether a component is rendered without having any effect on the rest of the processing. If a strategy lets this method return 'false', then the target component and its children will not be rendered, in the same fashion as if that component had visibility property 'false'.
  • The other use is when a component should block the rendering of the whole page. So instead of 'hiding' a component, what we generally want to achieve here is that we force the user to logon/give-credentials for a higher level of authorization. For this functionality, the strategy implementation should throw a org.apache.wicket.authorization.AuthorizationException, which will then be handled further by the framework.
488
 
489
 	public static final Action RENDER = new Action(.);
meta data key for missing body tags logging.
491
 
492
 	private static final MetaDataKey BORDER_KEY = new MetaDataKey(IComponentBorder.class)
493
 	{
494
 		private static final long serialVersionUID = 1L;
495
 	};
496
 
497
 	/* meta data for user specified markup id */
498
 	private static final MetaDataKey MARKUP_ID_KEY = new MetaDataKey(String.class)
499
 	{
500
 		private static final long serialVersionUID = 1L;
501
 	};
Basic model IModelComparator implementation for normal object models
503
 
504
 	private static final IModelComparator defaultModelComparator = new IModelComparator()
505
 	{
506
 		private static final long serialVersionUID = 1L;
507
 
508
 		public boolean compare(Component component, Object b)
509
 		{
510
 			final Object a = component.getModelObject();
511
 			if (a == null && b == null)
512
 			{
513
 				return true;
514
 			}
515
 			if (a == null || b == null)
516
 			{
517
 				return false;
518
 			}
519
 			return a.equals(b);
520
 		}
521
 	};
True when a component is being auto-added
523
 
524
 	private static final int FLAG_AUTO = 0x0001;
Flag for escaping HTML in model strings
526
 
527
 	private static final int FLAG_ESCAPE_MODEL_STRINGS = 0x0002;
Boolean whether this component's model is inheritable. 
531
 
532
 	static final int FLAG_INHERITABLE_MODEL = 0x0004;
Versioning boolean
534
 
535
 	private static final int FLAG_VERSIONED = 0x0008;
Visibility boolean
537
 
538
 	private static final int FLAG_VISIBLE = 0x0010;
Render tag boolean
540
 
541
 	private static final int FLAG_RENDER_BODY_ONLY = 0x0020;
Ignore attribute modifiers
543
 
544
 	private static final int FLAG_IGNORE_ATTRIBUTE_MODIFIER = 0x0040;
True when a component is enabled for model updates and is reachable.
546
 
547
 	private static final int FLAG_ENABLED = 0x0080;
Reserved subclass-definable flag bit
549
 
550
 	protected static final int FLAG_RESERVED1 = 0x0100;
Reserved subclass-definable flag bit
551
 
552
 	protected static final int FLAG_RESERVED2 = 0x0200;
Reserved subclass-definable flag bit
553
 
554
 	protected static final int FLAG_RESERVED3 = 0x0400;
Reserved subclass-definable flag bit
555
 
556
 	protected static final int FLAG_RESERVED4 = 0x0800;
Boolean whether this component was rendered at least once for tracking changes. 
560
 
561
 	private static final int FLAG_HAS_BEEN_RENDERED = 0x1000;
Internal indicator of whether this component may be rendered given the current context's authorization. It overrides the visible flag in case this is false. Authorization is done before trying to render any component (otherwise we would end up with a half rendered page in the buffer) 
568
 
569
 	private static final int FLAG_IS_RENDER_ALLOWED = 0x2000;
Whether or not the component should print out its markup id into the id attribute 
573
 
574
 	private static final int FLAG_OUTPUT_MARKUP_ID = 0x4000;
Output a placeholder tag if the component is not visible. This is useful in ajax mode to go to visible(false) to visible(true) without the overhead of repainting a visible parent container 
580
 
581
 	private static final int FLAG_PLACEHOLDER = 0x8000;
Reserved subclass-definable flag bit
583
 
584
 	protected static final int FLAG_RESERVED5 = 0x10000;
Reserved subclass-definable flag bit
585
 
586
 	protected static final int FLAG_RESERVED6 = 0x20000;
Reserved subclass-definable flag bit
587
 
588
 	protected static final int FLAG_RESERVED7 = 0x40000;
Reserved subclass-definable flag bit
589
 
590
 	protected static final int FLAG_RESERVED8 = 0x80000;
Flag that determines whether the model is set. This is necessary because of the way we represent component state (data). We can't distinguish between model and behavior using instanceof, because one object can implement both interfaces. Thus we need this flag - when the flag is set, first object in data is always model. 
597
 
598
 	private static final int FLAG_MODEL_SET = 0x100000;
599
 
600
 	private static final int FLAG_BEFORE_RENDERING_SUPER_CALL_VERIFIED = 0x1000000;
Flag that makes we are in before-render callback phase Set after component.onBeforeRender is invoked (right before invoking beforeRender on children) 
605
 
606
 	private static final int FLAG_PREPARED_FOR_RENDER = 0x4000000;
607
 	private static final int FLAG_RENDERING = 0x2000000;
608
 	private static final int FLAG_AFTER_RENDERING = 0x8000000;
609
 
610
 
611
 	private static final int FLAG_ATTACHED = 0x20000000;
612
 	private static final int FLAG_DETACHING = 0x80000000;
Log.
615
 
616
 	private static final Logger log = LoggerFactory.getLogger(Component.class);
The name of attribute that will hold markup id 
620
 
621
 	private static final String MARKUP_ID_ATTR_NAME = "id";
622
 
623
 	private static final long serialVersionUID = 1L;
Meta data key for line precise error logging for the moment of addition. Made package private for access in MarkupContainer and Page 
627
 
628
 	static final MetaDataKey ADDED_AT_KEY = new MetaDataKey(String.class)
629
 	{
630
 		private static final long serialVersionUID = 1L;
631
 	};
meta data key for line precise error logging for the moment of construction. Made package private for access in Page 
636
 
637
 	static final MetaDataKey CONSTRUCTED_AT_KEY = new MetaDataKey(String.class)
638
 	{
639
 		private static final long serialVersionUID = 1L;
640
 	};
Component flags. See FLAG_* for possible non-exclusive flag values.
642
 
Component id.
646
 
647
 	private String id;
Any parent container.
649
 
650
 	private MarkupContainer parent;
I really dislike it, but for now we need it. Reason: due to transparent containers and IComponentResolver there is guaranteed 1:1 mapping between component and markup 
655
 
656
 	int markupIndex = -1;
Instead of remembering the whole markupId, we just remember the number for this component so we can "reconstruct" the markupId on demand. While this could be part of data, profiling showed that having it as separate property consumes less memory. 
662
 
663
 	int generatedMarkupId = -1;
MetaDataEntry array. 
667
 
668
 // private MetaDataEntry[] metaData;
669
 //
670
 // /** List of behaviors to be applied for this Component */
671
 // private Object behaviors;
672
 //
673
 // /** The model for this component. */
674
 // IModel model;
675
 
The object that holds the component state.

What's stored here depends on what attributes are set on component. Data can contains combination of following attributes:

If there is only one attribute set (i.e. model or MetaDataEntry([]) or one behavior), the #data object points directly to value of that attribute. Otherwise the data is of type Object[] where the attributes are ordered as specified above. 

690
 
691
 	Object data = null;
692
 
693
 	private final int data_length()
694
 	{
695
 		if ( == null)
696
 		{
697
 			return 0;
698
 		}
699
 		else if ( instanceof Object[] && !( instanceof MetaDataEntry[]))
700
 		{
701
 			return ((Object[])).length;
702
 		}
703
 		else
704
 		{
705
 			return 1;
706
 		}
707
 	}
708
 
709
 	private final Object data_get(int index)
710
 	{
711
 		if ( == null)
712
 		{
713
 			return null;
714
 		}
715
 		else if ( instanceof Object[] && !( instanceof MetaDataEntry[]))
716
 		{
717
 			Object[] array = (Object[]);
718
 			return index < array.length ? array[index] : null;
719
 		}
720
 		else if (index == 0)
721
 		{
722
 			return ;
723
 		}
724
 		else
725
 		{
726
 			return null;
727
 		}
728
 	}
729
 
730
 	private final Object data_set(int index, Object object)
731
 	{
732
 		if (index > data_length() - 1)
733
 		{
735
 		}
736
 		else if (index == 0 && !( instanceof Object[] && !( instanceof MetaDataEntry[])))
737
 		{
738
 			Object old = ;
739
 			 = object;
740
 			return old;
741
 		}
742
 		else
743
 		{
744
 			Object[] array = (Object[]);
745
 			Object old = array[index];
746
 			array[index] = object;
747
 			return old;
748
 		}
749
 
750
 	}
751
 
752
 	private final void data_add(Object object)
753
 	{
754
 		data_insert(-1, object);
755
 	}
756
 
757
 	private final void data_insert(int position, Object object)
758
 	{
759
 		int currentLength = data_length();
760
 		if (position == -1)
761
 		{
762
 			position = currentLength;
763
 		}
764
 		if (position > currentLength)
765
 		{
767
 		}
768
 		if (currentLength == 0)
769
 		{
770
 			 = object;
771
 		}
772
 		else if (currentLength == 1)
773
 		{
774
 			Object[] array = new Object[2];
775
 			if (position == 0)
776
 			{
777
 				array[0] = object;
778
 				array[1] = ;
779
 			}
780
 			else
781
 			{
782
 				array[0] = ;
783
 				array[1] = object;
784
 			}
785
 			 = array;
786
 		}
787
 		else
788
 		{
789
 			Object[] array = new Object[currentLength + 1];
790
 			Object[] current = (Object[]);
791
 			int before = position;
792
 			int after = currentLength - position;
793
 			if (before > 0)
794
 			{
795
 				System.arraycopy(current, 0, array, 0, before);
796
 			}
797
 			array[position] = object;
798
 			if (after > 0)
799
 			{
800
 				System.arraycopy(current, position, array, position + 1, after);
801
 			}
802
 			 = array;
803
 		}
804
 	}
805
 
806
 	private Object data_remove(int position)
807
 	{
808
 		int currentLength = data_length();
809
 
810
 		if (position > currentLength - 1)
811
 		{
813
 		}
814
 
815
 		else if (currentLength == 1)
816
 		{
817
 			Object old = ;
818
 			 = null;
819
 			return old;
820
 		}
821
 		else if (currentLength == 2)
822
 		{
823
 			Object[] current = (Object[]);
824
 			if (position == 0)
825
 			{
826
 				 = current[1];
827
 				return current[0];
828
 			}
829
 			else
830
 			{
831
 				 = current[0];
832
 				return current[1];
833
 			}
834
 		}
835
 		else
836
 		{
837
 			Object[] current = (Object[]);
838
 			 = new Object[currentLength - 1];
839
 
840
 			if (position > 0)
841
 			{
842
 				System.arraycopy(current, 0, , 0, position);
843
 			}
844
 			if (position != currentLength - 1)
845
 			{
846
 				final int left = currentLength - position - 1;
847
 				System.arraycopy(current, position + 1, , position, left);
848
 			}
849
 
850
 			return current[position];
851
 		}
852
 	}
Constructor. All components have names. A component's id cannot be null. This is the minimal constructor of component. It does not register a model.

Parameters:
id The non-null id of this component
Throws:
WicketRuntimeException Thrown if the component has been given a null id.
862
 
863
 	public Component(final String id)
864
 	{
865
 		setId(id);
867
 
868
 		final IDebugSettings debugSettings = Application.get().getDebugSettings();
870
 		{
872
 				"constructed")));
873
 		}
874
 	}
Constructor. All components have names. A component's id cannot be null. This constructor includes a model.

Parameters:
id The non-null id of this component
model The component's model
Throws:
WicketRuntimeException Thrown if the component has been given a null id.
887
 
888
 	public Component(final String id, final IModel model)
889
 	{
890
 		this(id);
891
 		setModelImpl(wrap(model));
892
 	}
Adds an behavior modifier to the component.

Note: this method is override to enable users to do things like discussed in this thread.

Parameters:
behavior The behavior modifier to be added
Returns:
this (to allow method call chaining)
906
 
907
 	public Component add(final IBehavior behavior)
908
 	{
909
 		if (behavior == null)
910
 		{
911
 			throw new IllegalArgumentException("Argument may not be null");
912
 		}
913
 
914
 		addBehavior(behavior);
915
 
916
 		if (!behavior.isTemporary())
917
 		{
919
 		}
920
 
921
 		// Give handler the opportunity to bind this component
922
 		behavior.bind(this);
923
 
924
 		return this;
925
 	}
926
 
927
 	private void addBehavior(final IBehavior behavior)
928
 	{
929
 		data_add(behavior);
930
 	}
931
 
932
 	private List getBehaviorsImpl()
933
 	{
934
 		if ( != null)
935
 		{
936
 			// if the model is set, we must skip it
937
 			final int startIndex = getFlag() ? 1 : 0;
938
 			int length = data_length();
939
 
940
 			if (length > startIndex)
941
 			{
942
 				final ArrayList result = new ArrayList();
943
 				for (int i = startIndex; i < length; ++i)
944
 				{
945
 					Object o = data_get(i);
946
 					if (o instanceof IBehavior)
947
 					{
948
 						result.add(o);
949
 					}
950
 				}
951
 				return result;
952
 			}
953
 		}
954
 		return null;
955
 	}
Called on very component after the page is rendered. It will call onAfterRender for it self and its children. 
960
 
961
 	public final void afterRender()
962
 	{
963
 		// if the component has been previously attached via attach()
964
 		// detach it now
965
 		try
966
 		{
971
 			{
972
 				throw new IllegalStateException(Component.class.getName() +
973
 					" has not been properly detached. Something in the hierarchy of " +
975
 					" has not called super.onAfterRender() in the override of onAfterRender() method");
976
 			}
977
 			// always detach children because components can be attached
978
 			// independently of their parents
980
 		}
981
 		finally
982
 		{
983
 			// this flag must always be set to false.
985
 		}
986
 	}
987
 
988
 	private final void internalBeforeRender()
989
 	{
992
 		{
994
 
998
 			{
999
 				throw new IllegalStateException(Component.class.getName() +
1000
					" has not been properly rendered. Something in the hierarchy of " +
1002
					" has not called super.onBeforeRender() in the override of onBeforeRender() method");
1005
	}
We need to postpone calling beforeRender() on components that implement IFeedback, to be sure that all other component's beforeRender() has been already called, so that IFeedbacks can collect all feedback messages. This is the key under list of postponed IFeedback is stored to request cycle metadata. The List is then iterated over in prepareForRender() after calling beforeRender(), to initialize postponed components. 
1014
	private static final MetaDataKey FEEDBACK_LIST = new MetaDataKey(List.class)
1016
		private static final long serialVersionUID = 1L;
1017
	};
Called for every component when the page is getting to be rendered. it will call onBeforeRender for this component and all the child components 
1023
	public final void beforeRender()
1025
		if (!(this instanceof IFeedback))
1029
		else
1031
			// this component is a feedback. Feedback must be initialized last, so that
1032
			// they can collect messages from other components
1034
			if (feedbacks == null)
1036
				feedbacks = new ArrayList();
1039
			feedbacks.add(this);
1041
	}
Redirects to any intercept page previously specified by a call to redirectToInterceptPage.

Returns:
True if an original destination was redirected to
See also:
redirectToInterceptPage(org.apache.wicket.Page)
1049
	public final boolean continueToOriginalDestination()
1052
	}
Registers a debug feedback message for this component

Parameters:
message The feedback message
1060
	public final void debug(final String message)
1062
		Session.get().getFeedbackMessages().debug(this, message);
1063
		Session.get().dirty();
1064
	}
Detaches the component. This is called at the end of the request for all the pages that are touched in that request. 
1070
	public final void detach()
1072
		// if the component has been previously attached via attach()
1073
		// detach it now
1079
				" has not been properly detached. Something in the hierarchy of " +
1081
				" has not called super.onDetach() in the override of onDetach() method");
1085
		// always detach models because they can be attached without the
1086
		// component. eg component has a compoundpropertymodel and one of its
1087
		// children component's getmodelobject is called
1090
		// always detach children because components can be attached
1091
		// independently of their parents
1094
		// reset the model to null when the current model is a IWrapModel and
1095
		// the model that created it/wrapped in it is a IComponentInheritedModel
1096
		// The model will be created next time.
1102
	}
THIS IS WICKET INTERNAL ONLY. DO NOT USE IT. Traverses all behaviors and calls detachModel() on them. This is needed to cleanup behavior after render. This method is necessary for org.apache.wicket.ajax.AjaxRequestTarget to be able to cleanup component's behaviors after header contribution has been done (which is separated from component render). 
1112
	public final void detachBehaviors()
1114
		List behaviors = getBehaviorsImpl();
1115
		if (behaviors != null)
1117
			for (Iterator i = behaviors.iterator(); i.hasNext();)
1119
				IBehavior behavior = (IBehavior)i.next();
1121
				// Always detach models, 'accepted' or not. Otherwise, if they
1122
				// are accepted during render, but not here - something can go
1123
				// undetached, and calling isEnabled can also lead to nasty side
1124
				// effects. See for instance Timo's comment on
1125
				// http://issues.apache.org/jira/browse/WICKET-673
1126
				behavior.detach(this);
1128
				if (behavior.isTemporary())
1130
					removeBehavior(behavior);
1134
	}
Detaches all models 
1139
	public void detachModels()
1141
		// Detach any detachable model from this component
1144
		// detach any behaviors
1146
	}
Registers an error feedback message for this component

Parameters:
message The feedback message
1154
	public final void error(final Serializable message)
1156
		Session.get().getFeedbackMessages().error(this, message);
1157
		Session.get().dirty();
1158
	}
Registers an fatal error feedback message for this component

Parameters:
message The feedback message
1166
	public final void fatal(final String message)
1168
		Session.get().getFeedbackMessages().fatal(this, message);
1169
		Session.get().dirty();
1170
	}
Finds the first container parent of this component of the given class.

Parameters:
c MarkupContainer class to search for
Returns:
First container parent that is an instance of the given class, or null if none can be found
1180
	public final MarkupContainer findParent(final Class c)
1182
		// Start with immediate parent
1185
		// Walk up containment hierarchy
1186
		while (current != null)
1188
			// Is current an instance of this class?
1189
			if (c.isInstance(current))
1191
				return current;
1194
			// Check parent
1195
			current = current.getParent();
1198
		// Failed to find component
1199
		return null;
1200
	}

Returns:
The nearest markup container with associated markup
1207
		MarkupContainer container = ;
1208
		while (container != null)
1210
			if (container.hasAssociatedMarkup())
1212
				return container;
1214
			container = container.getParent();
1217
		// This should never happen since Page always has associated markup
1218
		throw new WicketRuntimeException("Unable to find parent with associated markup");
1219
	}
Gets interface to application that this component is a part of.

Returns:
The application associated with the session that this component is in.
See also:
Application
1227
	public final Application getApplication()
1229
		return Application.get();
1230
	}
Gets the currently coupled org.apache.wicket.behavior.IBehaviors as a unmodifiable list. Returns an empty list rather than null if there are no behaviors coupled to this component.

Returns:
The currently coupled behaviors as a unmodifiable list
1238
	public final List/* <IBehavior> */getBehaviors()
1240
		return getBehaviors(null);
1241
	}

Returns:
A path of the form [page-class-name].[page-relative-path]
See also:
getPageRelativePath()
1247
	public final String getClassRelativePath()
1250
	}

Returns:
component border assigned to this component, or null if none
1258
	}

Deprecated:
To be removed. Please use/ override getConverter(java.lang.Class) instead.
Returns:
nothing, will always throw an exception. Use getConverter(java.lang.Class) instead.
1264
	public final IConverter getConverter()
1266
		throw new UnsupportedOperationException("use #getConverter(Class) instead");
1267
	}
Gets the converter that should be used by this component.

Parameters:
type The type to convert to
Returns:
The converter that should be used by this component
1277
	public IConverter getConverter(Class/* <?> */type)
1280
	}
Gets whether model strings should be escaped.

Returns:
Returns whether model strings should be escaped
1287
	public final boolean getEscapeModelStrings()
1290
	}

Returns:
Any feedback message for this component
1297
		return Session.get().getFeedbackMessages().messageForComponent(this);
1298
	}
Gets the id of this component.

Returns:
The id of this component
1305
	public String getId()
1307
		return ;
1308
	}

Returns:
Innermost model for this component
1313
	public final IModel getInnermostModel()
1316
	}
Gets the locale for this component. By default, it searches its parents for a locale. If no parents (it's a recursive search) returns a locale, it gets one from the session.

Returns:
The locale to be used for this component
See also:
Session.getLocale()
1325
	public Locale getLocale()
1327
		Locale locale = null;
1328
		if ( != null)
1330
			locale = .getLocale();
1332
		return (locale != null) ? locale : getSession().getLocale();
1333
	}
Convenience method to provide easy access to the localizer object within any component.

Returns:
The localizer object
1340
	public final Localizer getLocalizer()
1343
	}
THIS IS WICKET INTERNAL ONLY. DO NOT USE IT. Get a copy of the markup's attributes which are associated with the component.

Modifications to the map returned don't change the tags attributes. It is just a copy.

Note: The component must have been added (directly or indirectly) to a container with an associated markup file (Page, Panel or Border).

Returns:
markup attributes
1359
		MarkupStream markupStream = locateMarkupStream();
1360
		ValueMap attrs = new ValueMap(markupStream.getTag().getAttributes());
1362
		return attrs;
1367
		if ( != -1)
1375
	private final int nextAutoIndex()
1377
		Page page = findPage();
1378
		if (page == null)
1381
				"This component is not (yet) coupled to a page. It has to be able "
1382
					+ "to find the page it is supposed to operate in before you can call "
1383
					+ "this method (Component#getMarkupId)");
1386
		return page.getAutoIndex();
1387
	}
Retrieves id by which this component is represented within the markup. This is either the id attribute set explicitly via a call to setMarkupId(java.lang.String), id attribute defined in the markup, or an automatically generated id - in that order.

If no explicit id is set this function will generate an id value that will be unique in the page. This is the preferred way as there is no chance of id collision.

Note: This method should only be called after the component or its parent have been added to the page.

Returns:
markup id of the component
1404
		Object storedMarkupId = getMarkupIdImpl();
1406
		if (storedMarkupId instanceof String)
1408
			return (String)storedMarkupId;
1411
		final int generatedMarkupId = storedMarkupId instanceof Integer
1412
			? ((Integer)storedMarkupId).intValue() : nextAutoIndex();
1414
		if (storedMarkupId == null)
1416
			setMarkupIdImpl(new Integer(generatedMarkupId));
1419
		// try to read from markup
1420
		// TODO getting the id from markup doesn't work everywhere yet.
1421
		// unfortunately, we have to drop this until we have a good solution
1422
		// for issue http://issues.apache.org/jira/browse/WICKET-694
1423
		// markupId = getMarkupAttributes().getString("id");
1425
		String markupId = RequestContext.get().encodeMarkupId(getId() + generatedMarkupId);
1426
		// make sure id is compliant with w3c requirements (starts with a
1427
		// letter)
1428
		char c = markupId.charAt(0);
1429
		if (!Character.isLetter(c))
1431
			markupId = "id" + markupId;
1434
		// escape some noncompliant characters
1435
		markupId = Strings.replaceAll(markupId, "_", "__").toString();
1436
		markupId = markupId.replace('.', '_');
1437
		markupId = markupId.replace('-', '_');
1439
		return markupId;
1440
	}
Gets metadata for this component using the given key.

Parameters:
key The key for the data
Returns:
The metadata or null of no metadata was found for the given key
See also:
MetaDataKey
1450
	public final Serializable getMetaData(final MetaDataKey key)
1452
		return key.get(getMetaData());
1457
		MetaDataEntry[] metaData = null;
1459
		// index where we should expect the entry
1460
		int index = getFlag() ? 1 : 0;
1462
		int length = data_length();
1464
		if (index < length)
1466
			Object object = data_get(index);
1467
			if (object instanceof MetaDataEntry[])
1469
				metaData = (MetaDataEntry[])object;
1471
			else if (object instanceof MetaDataEntry)
1473
				metaData = new MetaDataEntry[] { (MetaDataEntry)object };
1477
		return metaData;
1478
	}
Gets the model. It returns the object that wraps the backing model.

Returns:
The model
1485
	public final IModel getModel()
1487
		IModel model = getModelImpl();
1488
		// If model is null
1489
		if (model == null)
1491
			// give subclass a chance to lazy-init model
1492
			model = initModel();
1496
		return model;
1497
	}
Gets the backing model object; this is shorthand for getModel().getObject().

Returns:
The backing model object
1504
	public final Object getModelObject()
1506
		final IModel model = getModel();
1507
		if (model != null)
1509
			// Get model value for this component.
1510
			return model.getObject();
1512
		else
1514
			return null;
1516
	}
Gets a model object as a string. Depending on the "escape model strings" flag of the component, the string is either HTML escaped or not. "HTML escaped" meaning that only HTML sensitive chars are escaped but not all none-ascii chars. Proper HTML encoding should be used instead. In case you really need a fully escaped model string you may call org.apache.wicket.util.string.Strings.escapeMarkup(java.lang.String,boolean,boolean) on the model string returned.

Returns:
Model object for this component as a string
See also:
org.apache.wicket.util.string.Strings.escapeMarkup(java.lang.String,boolean,boolean)
getEscapeModelStrings()
1533
	}
Gets a model object as a string. Depending on the "escape model strings" flag of the component, the string is either HTML escaped or not. "HTML escaped" meaning that only HTML sensitive chars are escaped but not all none-ascii chars. Proper HTML encoding should be used instead. In case you really need a fully escaped model string you may call org.apache.wicket.util.string.Strings.escapeMarkup(java.lang.String,boolean,boolean) on the model string returned.

Parameters:
modelObject Model object to convert to string
Returns:
The string
See also:
org.apache.wicket.util.string.Strings.escapeMarkup(java.lang.String,boolean,boolean)
getEscapeModelStrings()
1549
	public final String getModelObjectAsString(final Object modelObject)
1551
		if (modelObject != null)
1553
			// Get converter
1554
			final IConverter converter = getConverter(modelObject.getClass());
1556
			// Model string from property
1557
			final String modelString = converter.convertToString(modelObject, getLocale());
1559
			if (modelString != null)
1561
				// If we should escape the markup
1564
					// Escape HTML sensitive characters only. Not all none-ascii chars
1565
					return Strings.escapeMarkup(modelString, false, false).toString();
1567
				return modelString;
1570
		return "";
1571
	}
Gets whether or not component will output id attribute into the markup. id attribute will be set to the value returned from getMarkupId().

Returns:
whether or not component will output id attribute into the markup
1579
	public final boolean getOutputMarkupId()
1582
	}
Gets whether or not an invisible component will render a placeholder tag.

Returns:
true if a placeholder tag should be rendered
1589
	public final boolean getOutputMarkupPlaceholderTag()
1592
	}
Gets the page holding this component.

Returns:
The page holding this component
Throws:
java.lang.IllegalStateException Thrown if component is not yet attached to a Page.
1601
	public final Page getPage()
1603
		// Search for nearest Page
1604
		final Page page = findPage();
1606
		// If no Page was found
1607
		if (page == null)
1609
			// Give up with a nice exception
1610
			throw new IllegalStateException("No Page found for component " + this);
1613
		return page;
1614
	}

Returns:
The page factory for the session that this component is in
1619
	public final IPageFactory getPageFactory()
1622
	}
Gets the path to this component relative to the page it is in.

Returns:
The path to this component relative to the page it is in
1629
	public final String getPageRelativePath()
1632
	}
Gets any parent container, or null if there is none.

Returns:
Any parent container, or null if there is none
1639
	public final MarkupContainer getParent()
1641
		return ;
1642
	}
Gets this component's path.

Returns:
Colon separated path to this component in the component hierarchy
1649
	public final String getPath()
1652
		for (Component c = this; c != null; c = c.getParent())
1654
			if (buffer.length() > 0)
1658
			buffer.prepend(c.getId());
1660
		return buffer.toString();
1661
	}
If false the component's tag will be printed as well as its body (which is default). If true only the body will be printed, but not the component's tag.

Returns:
If true, the component tag will not be printed
1669
	public final boolean getRenderBodyOnly()
1672
	}

Returns:
The request for this component's active request cycle
1677
	public final Request getRequest()
1679
		RequestCycle requestCycle = getRequestCycle();
1680
		if (requestCycle == null)
1682
			// Happens often with WicketTester when one forgets to call
1683
			// createRequestCycle()
1684
			throw new WicketRuntimeException("No RequestCycle is currently set!");
1686
		return requestCycle.getRequest();
1687
	}
Gets the active request cycle for this component

Returns:
The request cycle
1696
		return RequestCycle.get();
1697
	}

Returns:
The response for this component's active request cycle
1702
	public final Response getResponse()
1705
	}
Gets the current Session object.

Returns:
The Session that this component is in
1714
		return Session.get();
1715
	}

Returns:
Size of this Component in bytes
1720
	public long getSizeInBytes()
1722
		final MarkupContainer originalParent = ;
1723
		 = null;
1724
		long size = -1;
1725
		try
1727
			size = Objects.sizeof(this);
1729
		catch (Exception e)
1731
			.error("Exception getting size for component " + this, e);
1733
		 = originalParent;
1734
		return size;
1735
	}

Parameters:
key Key of string resource in property file
Returns:
The String
See also:
Localizer
1743
	public final String getString(final String key)
1745
		return getString(key, null);
1746
	}

Parameters:
key The resource key
model The model
Returns:
The formatted string
See also:
Localizer
1756
	public final String getString(final String key, final IModel model)
1758
		return getLocalizer().getString(key, this, model);
1759
	}

Parameters:
key The resource key
model The model
defaultValue A default value if the string cannot be found
Returns:
The formatted string
See also:
Localizer
1771
	public final String getString(final String key, final IModel model, final String defaultValue)
1773
		return getLocalizer().getString(key, this, model, defaultValue);
1774
	}
Gets the style of this component (see Session).

Returns:
The style of this component.
See also:
Session
Session.getStyle()
1784
	public final String getStyle()
1786
		String variation = getVariation();
1787
		String style = getSession().getStyle();
1788
		if (variation != null && !"".equals(variation))
1790
			if (style != null && !"".equals(style))
1792
				style = variation + "_" + style;
1794
			else
1796
				style = variation;
1799
		return style;
1800
	}
Gets the variation string of this component that will be used to look up markup for this component. Subclasses can override this method to define by an instance what markup variation should be picked up. By default it will return null or the value of a parent.

Returns:
The variation of this component.
1811
		String variation = null;
1812
		if ( != null)
1814
			variation = .getVariation();
1816
		return variation;
1817
	}
Gets whether this component was rendered at least once.

Returns:
true if the component has been rendered before, false if it is merely constructed
1824
	public final boolean hasBeenRendered()
1827
	}

Returns:
True if this component has an error message
1832
	public final boolean hasErrorMessage()
1834
		return Session.get().getFeedbackMessages().hasErrorMessageFor(this);
1835
	}

Returns:
True if this component has some kind of feedback message
1840
	public final boolean hasFeedbackMessage()
1842
		return Session.get().getFeedbackMessages().hasMessageFor(this);
1843
	}
Registers an informational feedback message for this component

Parameters:
message The feedback message
1851
	public final void info(final String message)
1853
		Session.get().getFeedbackMessages().info(this, message);
1854
		Session.get().dirty();
1855
	}

Deprecated:
1860
	// TODO remove after deprecation release
1861
	public final void internalAttach()
1864
	}

Deprecated:
1869
	// TODO remove after deprecation release
1870
	public final void internalDetach()
1873
	}
Authorizes an action for a component.

Parameters:
action The action to authorize
Returns:
True if the action is allowed
Throws:
org.apache.wicket.authorization.AuthorizationException Can be thrown by implementation if action is unauthorized
1884
	public final boolean isActionAuthorized(Action action)
1887
		if (authorizationStrategy != null)
1889
			return authorizationStrategy.isActionAuthorized(this, action);
1891
		return true;
1892
	}
Returns true if this component is an ancestor of the given component

Deprecated:
use getParent().contains(component, false)
Parameters:
component The component to check
Returns:
True if the given component has this component as an ancestor
1902
	public final boolean isAncestorOf(final Component component)
1904
		return getParent().contains(component, false);
1905
		// // Walk up containment hierarchy
1906
		// for (MarkupContainer current = component.parent; current != null;
1907
		// current = current
1908
		// .getParent())
1909
		// {
1910
		// // Is this an ancestor?
1911
		// if (current == this)
1912
		// {
1913
		// return true;
1914
		// }
1915
		// }
1916
		//
1917
		// // This component is not an ancestor of the given component
1918
		// return false;
1919
	}

Returns:
true if this component is authorized to be enabled, false otherwise
1924
	public final boolean isEnableAllowed()
1927
	}
Gets whether this component is enabled. Specific components may decide to implement special behavior that uses this property, like web form components that add a disabled='disabled' attribute when enabled is false.

Returns:
Whether this component is enabled.
1936
	public boolean isEnabled()
1939
	}
Checks the security strategy if the RENDER action is allowed on this component

Returns:
ture if RENDER action is allowed, false otherwise
1947
	public final boolean isRenderAllowed()
1950
	}
Returns if the component is stateless or not. It checks the stateless hint if that is false it returns directly false. If that is still true it checks all its behaviors if they can be stateless.

Returns:
whether the component is stateless.
1959
	public final boolean isStateless()
1963
			return false;
1966
		final Iterator behaviors = getBehaviors().iterator();
1968
		while (behaviors.hasNext())
1970
			IBehavior behavior = (IBehavior)behaviors.next();
1971
			if (!behavior.getStatelessHint(this))
1973
				return false;
1976
		return true;
1977
	}

Returns:
True if this component is versioned
1982
	public boolean isVersioned()
1984
		// Is the component itself versioned?
1987
			return false;
1989
		else
1991
			// If there's a parent and this component is versioned
1992
			if ( != null)
1994
				// Check if the parent is unversioned. If any parent
1995
				// (recursively) is unversioned, then this component is too
1998
					return false;
2001
			return true;
2003
	}
Gets whether this component and any children are visible.

WARNING: this method can be called multiple times during a request. If you override this method, it is a good idea to keep it cheap in terms of processing. Alternatively, you can call setVisible(boolean).

Returns:
True if component and any children are visible
2015
	public boolean isVisible()
2018
	}
Checks if the component itself and all its parents are visible.

Returns:
true if the component and all its parents are visible.
2025
	public final boolean isVisibleInHierarchy()
2027
		Component component = this;
2028
		while (component != null)
2030
			if (component.isRenderAllowed() && component.isVisible())
2032
				component = component.getParent();
2034
			else
2036
				return false;
2039
		return true;
2040
	}
Sets the RENDERING flag on component and it's children. 
2045
	public final void markRendering()
2048
	}
Called to indicate that the model content for this component has been changed 
2053
	public final void modelChanged()
2055
		// Call user code
2058
	}
Called to indicate that the model content for this component is about to change 
2063
	public final void modelChanging()
2067
		// Call user code
2070
		// Tell the page that our model changed
2071
		final Page page = findPage();
2072
		if (page != null)
2076
	}
Creates a new page using the component's page factory

Parameters:
c The class of page to create
Returns:
The new page
2085
	public final Page newPage(final Class c)
2088
	}
Creates a new page using the component's page factory

Parameters:
c The class of page to create
parameters Any parameters to pass to the constructor
Returns:
The new page
2099
	public final Page newPage(final Class c, final PageParameters parameters)
2101
		return getPageFactory().newPage(c, parameters);
2102
	}
Prepares the component and it's children for rendering. On whole page render this method must be called on the page. On AJAX request, this method must be called on updated component. 
2108
	public void prepareForRender()
2112
		if (feedbacks != null)
2114
			for (Iterator i = feedbacks.iterator(); i.hasNext();)
2116
				Component feedback = (Component)i.next();
2123
		// check authorization
2124
		// first the component itself
2125
		// (after attach as otherwise list views etc wont work)
2127
	}
Redirects browser to an intermediate page such as a sign-in page. The current request's url is saved for future use by method continueToOriginalDestination(); Only use this method when you plan to continue to the current url at some later time; otherwise just use setResponsePage or - when you are in a constructor or checkAccessMethod, call redirectTo.

Parameters:
page The sign in page
See also:
continueToOriginalDestination()
2140
	public final void redirectToInterceptPage(final Page page)
2143
	}
Removes this component from its parent. It's important to remember that a component that is removed cannot be referenced from the markup still. 
2149
	public final void remove()
2151
		if ( == null)
2153
			throw new IllegalStateException("Cannot remove " + this + " from null parent!");
2157
	}
Removes behavior from component

Parameters:
behavior behavior to remove
Returns:
this (to allow method call chaining)
2167
	public Component remove(final IBehavior behavior)
2169
		if (behavior == null)
2171
			throw new IllegalArgumentException("Argument `behavior` cannot be null");
2174
		if (removeBehavior(behavior))
2176
			if (!behavior.isTemporary())
2181
		else
2184
				"Tried to remove a behavior that was not added to the component. Behavior: " +
2185
					behavior.toString());
2187
		return this;
2190
	private boolean removeBehavior(final IBehavior behavior)
2192
		final int start = getFlag() ? 1 : 0;
2193
		for (int i = start; i < data_length(); ++i)
2195
			Object o = data_get(i);
2196
			if (o.equals(behavior))
2199
				return true;
2202
		return false;
2203
	}
Performs a render of this component as part of a Page level render process.

For component level re-render (e.g. AJAX) please call renderComponent(). Though render() does seem to work, it will fail for panel children. 

2211
	public final void render()
2213
		// Allow currently invisible components to be re-rendered as well
2214
		MarkupStream markupStream = null;
2215
		if (getParent() != null)
2217
			markupStream = findMarkupStream();
2220
		render(markupStream);
2221
	}
Performs a render of this component as part of a Page level render process.

For component level re-render (e.g. AJAX) please call renderComponent(org.apache.wicket.markup.MarkupStream). Though render() does seem to work, it will fail for panel children.

Parameters:
markupStream
2232
	public final void render(final MarkupStream markupStream)
2234
		// We need to know the index before we do the visibility check.
2235
		// Otherwise
2236
		// we wouldn't know the markup index for invisible components
2237
		if (markupStream != null)
2239
			 = markupStream.getCurrentIndex();
2244
		setMarkupStream(markupStream);
2247
		// Determine if component is visible using it's authorization status
2248
		// and the isVisible property.
2251
			// Rendering is beginning
2254
				.debug("Begin render " + this);
2257
			try
2259
				// Call implementation to render component
2262
				if (border != null)
2264
					border.renderBefore(this);
2266
				onRender(markupStream);
2267
				if (border != null)
2269
					border.renderAfter(this);
2271
				// Component has been rendered
2274
			catch (RuntimeException ex)
2276
				// Call each behaviors onException() to allow the
2277
				// behavior to clean up
2278
				List behaviors = getBehaviorsImpl();
2279
				if (behaviors != null)
2281
					for (Iterator i = behaviors.iterator(); i.hasNext();)
2283
						IBehavior behavior = (IBehavior)i.next();
2284
						if (isBehaviorAccepted(behavior))
2286
							try
2288
								behavior.exception(this, ex);
2290
							catch (Throwable ex2)
2292
								.error("Error while cleaning up after exception", ex2);
2298
				// Re-throw the exception
2299
				throw ex;
2304
				.debug("End render " + this);
2307
		// markupStream is null when rendering a page
2308
		else if (markupStream != null)
2312
				// write out a placeholder tag into the markup
2313
				final ComponentTag tag = markupStream.getTag();
2315
				String namespacePrefix = Strings.isEmpty(tag.getNamespace()) ? null
2316
					: tag.getNamespace() + ":";
2319
				if (namespacePrefix != null)
2321
					getResponse().write(namespacePrefix);
2324
				getResponse().write(" id=\"");
2326
				getResponse().write("\" style=\"display:none\"></");
2327
				if (namespacePrefix != null)
2329
					getResponse().write(namespacePrefix);
2334
			markupStream.skipComponent();
2336
	}
Page.renderPage() is used to render a whole page. With AJAX however it must be possible to render any one component contained in a page. That is what this method is for.

Note: it is not necessary that the page has previously been rendered. But the component must have been added (directly or indirectly) to a container with an associated markup file (Page, Panel or Border). 

2346
	public final void renderComponent()
2348
		// If this Component is a Page
2349
		if (this instanceof Page)
2351
			// Render as Page, with all the special logic that entails
2352
			((Page)this).renderPage();
2354
		else
2356
			// Save the parent's markup stream to re-assign it at the end
2358
			MarkupStream originalMarkupStream = parent.getMarkupStream();
2359
			MarkupStream markupStream = locateMarkupStream();
2361
			try
2363
				// Make sure that while rendering the markup stream is found
2364
				parent.setMarkupStream(markupStream);
2368
				// Render the component and all its children
2369
				render(markupStream);
2371
			finally
2373
				// Make sure the original markup stream is back in place
2374
				parent.setMarkupStream(originalMarkupStream);
2378
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT.

Renders the component at the current position in the given markup stream. The method onComponentTag() is called to allow the component to mutate the start tag. The method onComponentTagBody() is then called to permit the component to render its body.

Parameters:
markupStream The markup stream
2391
	public final void renderComponent(final MarkupStream markupStream)
2393
		 = markupStream.getCurrentIndex();
2395
		// Get mutable copy of next tag
2396
		final ComponentTag openTag = markupStream.getTag();
2397
		final ComponentTag tag = openTag.mutable();
2399
		// Call any tag handler
2402
		// If we're an openclose tag
2403
		if (!tag.isOpenClose() && !tag.isOpen())
2405
			// We were something other than <tag> or <tag/>
2406
			markupStream.throwMarkupException("Method renderComponent called on bad markup element: " +
2407
				tag);
2410
		if (tag.isOpenClose() && openTag.isOpen())
2412
			markupStream.throwMarkupException("You can not modify a open tag to open-close: " + tag);
2415
		try
2417
			// Render open tag
2418
			if (getRenderBodyOnly() == false)
2422
			markupStream.next();
2424
			// Render the body only if open-body-close. Do not render if
2425
			// open-close.
2426
			if (tag.isOpen())
2428
				// Render the body
2429
				onComponentTagBody(markupStream, tag);
2432
			// Render close tag
2433
			if (tag.isOpen())
2435
				if (openTag.isOpen())
2439
				else
2441
					// If a open-close tag has been to modified to be
2442
					// open-body-close than a synthetic close tag must be
2443
					// rendered.
2444
					if (getRenderBodyOnly() == false)
2446
						final boolean ajaxRequest = getRequest() instanceof WebRequest &&
2449
						final boolean stripWicketTags = ajaxRequest ||
2452
						if (!(openTag instanceof WicketTag) || !stripWicketTags)
2454
							// Close the manually opened panel tag.
2461
		catch (RuntimeException re)
2463
			if (re instanceof WicketRuntimeException || re instanceof AbortException)
2465
				throw re;
2467
			throw new WicketRuntimeException("Exception in rendering component: " + this, re);
2469
	}
Called to indicate that a component has been rendered. This method should only very rarely be called at all. One usage is in ImageMap, which renders its link children its own special way (without calling render() on them). If ImageMap did not call rendered() to indicate that its child components were actually rendered, the framework would think they had never been rendered, and in development mode this would result in a runtime exception. 
2478
	public final void rendered()
2481
		// Tell the page that the component rendered
2483
	}
Print to the web response what ever the component wants to contribute to the head section. Make sure that all attached behaviors are asked as well.

NOT intended for overriding by framework clients. Rather, use org.apache.wicket.markup.html.IHeaderContributor.renderHead(org.apache.wicket.markup.html.IHeaderResponse)

Parameters:
container The HtmlHeaderContainer
2496
	public void renderHead(final HtmlHeaderContainer container)
2498
		if (isVisible())
2500
			if (this instanceof IHeaderContributor)
2505
			// Ask all behaviors if they have something to contribute to the
2506
			// header or body onLoad tag.
2507
			List behaviors = getBehaviorsImpl();
2508
			if (behaviors != null)
2510
				final Iterator iter = behaviors.iterator();
2511
				while (iter.hasNext())
2513
					IBehavior behavior = (IBehavior)iter.next();
2514
					if (behavior instanceof IHeaderContributor && isBehaviorAccepted(behavior))
2521
	}
Replaces this component with another. The replacing component must have the same component id as this component. This method serves as a shortcut to this.getParent().replace(replacement) and provides a better context for errors.

Parameters:
replacement component to replace this one
Since:
1.2.1
2534
	public void replaceWith(Component replacement)
2536
		if (replacement == null)
2538
			throw new IllegalArgumentException("Argument [[replacement]] cannot be null.");
2540
		if (!getId().equals(replacement.getId()))
2543
				"Replacement component must have the same id as the component it will replace. Replacement id [[" +
2544
					replacement.getId() + "]], replaced id [[" + getId() + "]].");
2546
		if ( == null)
2549
				"This method can only be called on a component that has already been added to its parent.");
2551
		.replace(replacement);
2552
	}

Parameters:
component The component to compare with
Returns:
True if the given component's model is the same as this component's model.
2559
	public final boolean sameInnermostModel(final Component component)
2561
		return sameInnermostModel(component.getModel());
2562
	}

Parameters:
model The model to compare with
Returns:
True if the given component's model is the same as this component's model.
2569
	public final boolean sameInnermostModel(final IModel model)
2571
		// Get the two models
2572
		IModel thisModel = getModel();
2573
		IModel thatModel = model;
2575
		// If both models are non-null they could be the same
2576
		if (thisModel != null && thatModel != null)
2578
			return getInnermostModel(thisModel) == getInnermostModel(thatModel);
2581
		return false;
2582
	}
Assigns a component border to this component. If called with null any previous border will be cleared.

Parameters:
border component border to assign, or null to clear any previous
Returns:
component for chaining
2592
	public final Component setComponentBorder(final IComponentBorder border)
2594
		if (!Objects.equal(getComponentBorder(), border))
2599
		return this;
2600
	}
Sets whether this component is enabled. Specific components may decide to implement special behavior that uses this property, like web form components that add a disabled='disabled' attribute when enabled is false. If it is not enabled, it will not be allowed to call any listener method on it (e.g. Link.onClick) and the model object will be protected (for the common use cases, not for programmer's misuse)

Parameters:
enabled whether this component is enabled
Returns:
This
2613
	public final Component setEnabled(final boolean enabled)
2615
		// Is new enabled state a change?
2616
		if (enabled != getFlag())
2618
			// Tell the page that this component's enabled was changed
2621
				final Page page = findPage();
2622
				if (page != null)
2628
			// Change visibility
2631
		return this;
2632
	}
Sets whether model strings should be escaped.

Parameters:
escapeMarkup True is model strings should be escaped
Returns:
This
2641
	public final Component setEscapeModelStrings(final boolean escapeMarkup)
2644
		return this;
2647
	final void setMarkupIdImpl(Object markupId)
2649
		if (markupId != null && !(markupId instanceof String) && !(markupId instanceof Integer))
2651
			throw new IllegalArgumentException("markupId must be String or Integer");
2654
		if (markupId instanceof Integer)
2658
			return;
2662
	}
Sets this component's markup id to a user defined value. It is up to the user to ensure this value is unique.

The recommended way is to let wicket generate the value automatically, this method is here to serve as an override for that value in cases where a specific id must be used.

If null is passed in the user defined value is cleared and markup id value will fall back on automatically generated value

Parameters:
markupId markup id value or null to clear any previous user defined value
See also:
getMarkupId()
2679
	public void setMarkupId(String markupId)
2681
		if (markupId != null && Strings.isEmpty(markupId))
2683
			throw new IllegalArgumentException("Markup id cannot be an empty string");
2687
	}
Sets the metadata for this component using the given key. If the metadata object is not of the correct type for the metadata key, an IllegalArgumentException will be thrown. For information on creating MetaDataKeys, see MetaDataKey.

Parameters:
key The singleton key for the metadata
object The metadata object
Throws:
java.lang.IllegalArgumentException
See also:
MetaDataKey
2701
	public final void setMetaData(final MetaDataKey key, final Serializable object)
2705
		Object metaData = null;
2706
		MetaDataEntry[] metaDataArray = key.set(getMetaData(), object);
2707
		if (metaDataArray != null && metaDataArray.length > 0)
2709
			metaData = (metaDataArray.length > 1) ? (Object)metaDataArray : metaDataArray[0];
2712
		int index = getFlag() ? 1 : 0;
2714
		if (old == null && metaData != null)
2716
			data_insert(index, metaData);
2718
		else if (old != null && metaData != null)
2720
			data_set(index, metaData);
2722
		else if (old != null && metaData == null)
2726
	}
Sets the given model.

WARNING: DO NOT OVERRIDE THIS METHOD UNLESS YOU HAVE A VERY GOOD REASON FOR IT. OVERRIDING THIS MIGHT OPEN UP SECURITY LEAKS AND BREAK BACK-BUTTON SUPPORT.

Parameters:
model The model
Returns:
This
2739
	public Component setModel(final IModel model)
2741
		IModel prevModel = getModelImpl();
2742
		// Detach current model
2743
		if (prevModel != null)
2745
			prevModel.detach();
2748
		if (prevModel instanceof IWrapModel)
2750
			prevModel = ((IWrapModel)prevModel).getWrappedModel();
2753
		// Change model
2754
		if (prevModel != model)
2756
			if (prevModel != null)
2765
		return this;
2772
			return (IModel)data_get(0);
2774
		else
2776
			return null;
2780
	void setModelImpl(IModel model)
2784
			if (model != null)
2786
				data_set(0, model);
2788
			else
2794
		else
2796
			if (model != null)
2798
				data_insert(0, model);
2804
	}
Sets the backing model object; shorthand for getModel().setObject(object).

Parameters:
object The object to set
Returns:
This
2813
	public final Component setModelObject(final Object object)
2815
		final IModel model = getModel();
2817
		// Check whether anything can be set at all
2818
		if (model == null)
2821
				"Attempt to set model object on null model of component: " + getPageRelativePath());
2824
		// Check authorization
2830
		// Check whether this will result in an actual change
2831
		if (!getModelComparator().compare(this, object))
2834
			model.setObject(object);
2838
		return this;
2839
	}
Sets whether or not component will output id attribute into the markup. id attribute will be set to the value returned from getMarkupId().

Parameters:
output True if the component will out the id attribute into markup. Please note that the default behavior is to use the same id as the component. This means that your component must begin with [a-zA-Z] in order to generate a valid markup id according to: http://www.w3.org/TR/html401/types.html#type-name
Returns:
this for chaining
2853
	public final Component setOutputMarkupId(final boolean output)
2856
		return this;
2857
	}
Render a placeholder tag when the component is not visible. The tag is of form: <componenttag style="display:none;" id="componentid"/>. This method will also call setOutputMarkupId(true). This is useful, for example, in ajax situations where the component starts out invisible and then becomes visible through an ajax update. With a placeholder tag already in the markup you do not need to repaint this component's parent, instead you can repaint the component directly. When this method is called with parameter false the outputmarkupid flag is not reverted to false.

Parameters:
outputTag
Returns:
this for chaining
2875
	public final Component setOutputMarkupPlaceholderTag(final boolean outputTag)
2877
		if (outputTag != getFlag())
2879
			if (outputTag)
2884
			else
2887
				// I think it's better to not setOutputMarkupId to false...
2888
				// user can do it if we want
2891
		return this;
2892
	}

Parameters:
redirect True if the response should be redirected to
See also:
RequestCycle.setRedirect(boolean)
2899
	public final void setRedirect(final boolean redirect)
2902
	}
If false the component's tag will be printed as well as its body (which is default). If true only the body will be printed, but not the component's tag.

Parameters:
renderTag If true, the component tag will not be printed
Returns:
This
2912
	public final Component setRenderBodyOnly(final boolean renderTag)
2915
		return this;
2916
	}
Sets the page that will respond to this request

Parameters:
cls The response page class
See also:
RequestCycle.setResponsePage(java.lang.Class)
2925
	public final void setResponsePage(final Class cls)
2928
	}
Sets the page class and its parameters that will respond to this request

Parameters:
cls The response page class
parameters The parameters for this bookmarkable page.
See also:
RequestCycle.setResponsePage(java.lang.Class,org.apache.wicket.PageParameters)
2940
	public final void setResponsePage(final Class cls, PageParameters parameters)
2942
		getRequestCycle().setResponsePage(cls, parameters);
2943
	}
Sets the page that will respond to this request

Parameters:
page The response page
See also:
RequestCycle.setResponsePage(org.apache.wicket.Page)
2952
	public final void setResponsePage(final Page page)
2955
	}

Parameters:
versioned True to turn on versioning for this component, false to turn it off for this component and any children.
Returns:
This
2963
	public Component setVersioned(boolean versioned)
2966
		return this;
2967
	}
Sets whether this component and any children are visible.

Parameters:
visible True if this component and any children should be visible
Returns:
This
2976
	public final Component setVisible(final boolean visible)
2978
		// Is new visibility state a change?
2979
		if (visible != getFlag())
2981
			// record component's visibility change
2984
			// Change visibility
2987
		return this;
2988
	}
Gets the string representation of this component.

Returns:
The path to this component
2995
	public String toString()
2997
		return toString(true);
2998
	}

Parameters:
detailed True if a detailed string is desired
Returns:
The string
3005
	public String toString(final boolean detailed)
3007
		if (detailed)
3009
			final Page page = findPage();
3010
			if (page == null)
3012
				return new StringBuffer("[Component id = ").append(getId()).append(
3013
					", page = <No Page>, path = ").append(getPath()).append(".").append(
3014
					Classes.simpleName(getClass())).append("]").toString();
3016
			else
3018
				return new StringBuffer("[Component id = ").append(getId())
3019
					.append(", page = ")
3021
					.append(", path = ")
3023
					.append(".")
3025
					.append(", isVisible = ")
3027
					.append(", isVersioned = ")
3029
					.append("]")
3033
		else
3035
			return "[Component id = " + getId() + "]";
3037
	}
Returns a bookmarkable URL that references a given page class using a given set of page parameters. Since the URL which is returned contains all information necessary to instantiate and render the page, it can be stored in a user's browser as a stable bookmark.

Parameters:
pageClass Class of page
parameters Parameters to page
Returns:
Bookmarkable URL to page
See also:
RequestCycle.urlFor(org.apache.wicket.IPageMap,java.lang.Class,org.apache.wicket.PageParameters)
3052
	public final CharSequence urlFor(final Class pageClass, final PageParameters parameters)
3054
		return getRequestCycle().urlFor(getPage().getPageMap(), pageClass, parameters);
3055
	}
Gets a URL for the listener interface on a behavior (e.g. IBehaviorListener on AjaxPagingNavigationBehavior).

Parameters:
behaviour The behavior that the URL should point to
listener The listener interface that the URL should call
Returns:
The URL
3067
	public final CharSequence urlFor(final IBehavior behaviour,
3068
		final RequestListenerInterface listener)
3070
		return getRequestCycle().urlFor(this, behaviour, listener);
3071
	}
Returns a bookmarkable URL that references a given page class using a given set of page parameters. Since the URL which is returned contains all information necessary to instantiate and render the page, it can be stored in a user's browser as a stable bookmark.

Parameters:
pageMap Page map to use
pageClass Class of page
parameters Parameters to page
Returns:
Bookmarkable URL to page
See also:
RequestCycle.urlFor(org.apache.wicket.IPageMap,java.lang.Class,org.apache.wicket.PageParameters)
3090
	public final CharSequence urlFor(final IPageMap pageMap, final Class pageClass,
3091
		final PageParameters parameters)
3093
		return getRequestCycle().urlFor(pageMap, pageClass, parameters);
3094
	}
Returns a URL that references the given request target.

Parameters:
requestTarget the request target to reference
Returns:
a URL that references the given request target
See also:
RequestCycle.urlFor(org.apache.wicket.IRequestTarget)
3106
	public final CharSequence urlFor(final IRequestTarget requestTarget)
3108
		return getRequestCycle().urlFor(requestTarget);
3109
	}
Gets a URL for the listener interface (e.g. ILinkListener).

Parameters:
listener The listener interface that the URL should call
Returns:
The URL
3118
	public final CharSequence urlFor(final RequestListenerInterface listener)
3120
		return getRequestCycle().urlFor(this, listener);
3121
	}
Returns a URL that references a shared resource through the provided resource reference.

Parameters:
resourceReference The resource reference
Returns:
The url for the shared resource
See also:
RequestCycle.urlFor(org.apache.wicket.ResourceReference)
3132
	public final CharSequence urlFor(final ResourceReference resourceReference)
3134
		return getRequestCycle().urlFor(resourceReference);
3135
	}
Traverses all parent components of the given class in this container, calling the visitor's visit method at each one.

Parameters:
c Class
visitor The visitor to call at each parent of the given type
Returns:
First non-null value returned by visitor callback
3147
	public final Object visitParents(final Class c, final IVisitor visitor)
3149
		// Start here
3150
		Component current = this;
3152
		// Walk up containment hierarchy
3153
		while (current != null)
3155
			// Is current an instance of this class?
3156
			if (c.isInstance(current))
3158
				final Object object = visitor.component(current);
3159
				if (object != .)
3161
					return object;
3165
			// Check parent
3166
			current = current.getParent();
3168
		return null;
3169
	}
Registers a warning feedback message for this component.

Parameters:
message The feedback message
3177
	public final void warn(final String message)
3179
		Session.get().getFeedbackMessages().warn(this, message);
3180
		Session.get().dirty();
3181
	}
org.apache.wicket.behavior.IBehavior.beforeRender(org.apache.wicket.Component) Notify all behaviors that are assigned to this component that the component is about to be rendered. 
3189
		List behaviors = getBehaviorsImpl();
3190
		if (behaviors != null)
3192
			for (Iterator i = behaviors.iterator(); i.hasNext();)
3194
				IBehavior behavior = (IBehavior)i.next();
3195
				if (isBehaviorAccepted(behavior))
3197
					behavior.beforeRender(this);
3201
	}
org.apache.wicket.behavior.IBehavior.afterRender(org.apache.wicket.Component) Notify all behaviors that are assigned to this component that the component has rendered. 
3209
		// notify the behaviors that component has been rendered
3210
		List behaviors = getBehaviorsImpl();
3211
		if (behaviors != null)
3213
			for (Iterator i = behaviors.iterator(); i.hasNext();)
3215
				IBehavior behavior = (IBehavior)i.next();
3216
				if (isBehaviorAccepted(behavior))
3218
					behavior.afterRender(this);
3222
	}
Adds state change to page.

Parameters:
change The change
3230
	protected final void addStateChange(final Change change)
3233
		final Page page = findPage();
3234
		if (page != null)
3236
			page.componentStateChanging(this, change);
3238
	}
Checks whether the given type has the expected name.

Parameters:
tag The tag to check
name The expected tag name
Throws:
org.apache.wicket.markup.MarkupException Thrown if the tag is not of the right name
3250
	protected final void checkComponentTag(final ComponentTag tag, final String name)
3252
		if (!tag.getName().equalsIgnoreCase(name))
3255
				"Component " + getId() + " must be applied to a tag of type '" + name + "', not " +
3258
	}
Checks that a given tag has a required attribute value.

Parameters:
tag The tag
key The attribute key
value The required value for the attribute key
Throws:
org.apache.wicket.markup.MarkupException Thrown if the tag does not have the required attribute value
3272
	protected final void checkComponentTagAttribute(final ComponentTag tag, final String key,
3273
		final String value)
3275
		if (key != null)
3277
			final String tagAttributeValue = tag.getAttributes().getString(key);
3278
			if (tagAttributeValue == null || !value.equalsIgnoreCase(tagAttributeValue))
3281
					"Component " + getId() + " must be applied to a tag with '" + key +
3282
						"' attribute matching '" + value + "', not '" + tagAttributeValue + "'");
3285
	}
Checks whether the hierarchy may be changed at all, and throws an exception if this is not the case.

Parameters:
component the component which is about to be added or removed
3294
	protected void checkHierarchyChange(final Component component)
3296
		// Throw exception if modification is attempted during rendering
3297
		if (!component.isAuto() && getFlag())
3300
				"Cannot modify component hierarchy during render phase");
3302
	}
Detaches the model for this component if it is detachable. 
3307
	protected void detachModel()
3309
		IModel model = getModelImpl();
3310
		if (model != null)
3312
			model.detach();
3314
		// also detach the wrapped model of a component assigned wrap (not
3315
		// inherited)
3316
		if (model instanceof IWrapModel && !getFlag())
3320
	}
Prefixes an exception message with useful information about this. component.

Parameters:
message The message
Returns:
The modified message
3329
	protected final String exceptionMessage(final String message)
3331
		return message + ":\n" + toString();
3332
	}
Finds the markup stream for this component.

Returns:
The markup stream for this component. Since a Component cannot have a markup stream, we ask this component's parent to search for it.
3342
		if ( == null)
3344
			throw new IllegalStateException("Cannot find markupstream for " + this +
3345
				" as there is no parent");
3349
	}
If this Component is a Page, returns self. Otherwise, searches for the nearest Page parent in the component hierarchy. If no Page parent can be found, null is returned.

Returns:
The Page or null if none can be found
3357
	protected final Page findPage()
3359
		// Search for page
3360
		return (Page)(this instanceof Page ? this : findParent(Page.class));
3361
	}
Gets the subset of the currently coupled org.apache.wicket.behavior.IBehaviors that are of the provided type as a unmodifiable list or null if there are no behaviors attached. Returns an empty list rather than null if there are no behaviors coupled to this component.

Parameters:
type The type or null for all
Returns:
The subset of the currently coupled behaviors that are of the provided type as a unmodifiable list or null
3374
	protected List/* <IBehavior> */getBehaviors(Class type)
3376
		List behaviors = getBehaviorsImpl();
3377
		if (behaviors == null)
3382
		List subset = new ArrayList(behaviors.size()); // avoid growing
3383
		for (Iterator i = behaviors.iterator(); i.hasNext();)
3385
			Object behavior = i.next();
3386
			if (type == null || type.isAssignableFrom(behavior.getClass()))
3388
				subset.add(behavior);
3391
		return Collections.unmodifiableList(subset);
3392
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!

Parameters:
flag The flag to test
Returns:
True if the flag is set
3401
	protected final boolean getFlag(final int flag)
3403
		return ( & flag) != 0;
3404
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!

Parameters:
flag The flag to test
Returns:
True if the flag is set
3413
	protected final boolean getFlag(final short flag)
3415
		return getFlag((int)flag);
3416
	}
Finds the innermost IModel object for an IModel that might contain nested IModel(s).

Parameters:
model The model
Returns:
The innermost (most nested) model
3425
	protected final IModel getInnermostModel(final IModel model)
3427
		IModel nested = model;
3428
		while (nested != null && nested instanceof IWrapModel)
3430
			final IModel next = ((IWrapModel)nested).getWrappedModel();
3431
			if (nested == next)
3433
				throw new WicketRuntimeException("Model for " + nested + " is self-referential");
3435
			nested = next;
3437
		return nested;
3438
	}
Gets the value defaultModelComparator. Implementations of this interface can be used in the Component.getComparator() for testing the current value of the components model data with the new value that is given.

Returns:
the value defaultModelComparator
3450
	}
Returns whether the component can be stateless. Also the component behaviors must be stateless, otherwise the component will be treat as stateful. In order for page to be stateless (and not to be stored in session), all components (and component behaviors) must be stateless.

Returns:
whether the component can be stateless
3460
	protected boolean getStatelessHint()
3462
		return true;
3463
	}
Called when a null model is about to be retrieved in order to allow a subclass to provide an initial model. This gives FormComponent, for example, an opportunity to instantiate a model on the fly using the containing Form's model.

Returns:
The model
3472
	protected IModel initModel()
3474
		// Search parents for CompoundPropertyModel
3475
		for (Component current = getParent(); current != null; current = current.getParent())
3477
			// Get model
3478
			// Don't call the getModel() that could initialize many inbetween
3479
			// completely useless models.
3480
			// IModel model = current.getModel();
3481
			IModel model = current.getModelImpl();
3483
			if (model instanceof IWrapModel && !(model instanceof IComponentInheritedModel))
3485
				model = ((IWrapModel)model).getWrappedModel();
3488
			if (model instanceof IComponentInheritedModel)
3490
				// return the shared inherited
3493
				return model;
3497
		// No model for this component!
3498
		return null;
3499
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called when a request begins.

Deprecated:
use onBeforeRender() instead
3508
	protected final void internalOnAttach()
3510
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called when a request ends.

Deprecated:
use onBeforeRender() instead
3520
	protected final void internalOnDetach()
3522
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called anytime a model is changed via setModel or setModelObject. 
3529
	protected void internalOnModelChanged()
3531
	}
Convenience method that sets the attached flags.

Parameters:
attached
3538
	protected final void markAttached(boolean attached)
3541
	}

Returns:
true if this component is attached
3546
	protected final boolean isAttached()
3549
	}
Components are allowed to reject behavior modifiers.

Parameters:
behavior
Returns:
False, if the component should not apply this behavior
3557
	protected boolean isBehaviorAccepted(final IBehavior behavior)
3559
		// Ignore AttributeModifiers when FLAG_IGNORE_ATTRIBUTE_MODIFIER is set
3560
		if ((behavior instanceof AttributeModifier) &&
3563
			return false;
3566
		return behavior.isEnabled(this);
3567
	}
If true, all attribute modifiers will be ignored

Returns:
True, if attribute modifiers are to be ignored
3574
	protected final boolean isIgnoreAttributeModifier()
3577
	}

Returns:
Component's markup stream
3584
		return new MarkupFragmentFinder().find(this);
3585
	}
Called just after a component is rendered. 
3590
	protected void onAfterRender()
3593
	}
The onAttach method is no longer available.

If you need to initialize component before it is rendered, either use onBeforeRender() or do the initialization lazily (on first demand, such as org.apache.wicket.model.LoadableDetachableModel does.

If you need to get notification when page is taken out of Session (before calling the event listener), you can use the Page.onPageAttached() method.

Deprecated:
3607
	protected final void onAttach()
3610
	}
Called just before a component is rendered.

*NOTE* If you override this, you *must* call super.onBeforeRender() within your implementation. Because this method is responsible for cascading onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

See also:
callOnBeforeRenderIfNotVisible()
3624
	protected void onBeforeRender()
3629
	}
Override this method if you want onBeforeRender to be called even when your component is not visible. default this returns false.

Returns:
boolean, if true then onBeforeRender is called even for none visible components, default false.
See also:
onBeforeRender()
3640
	protected boolean callOnBeforeRenderIfNotVisible()
3642
		return false;
3643
	}

Deprecated:
use onAttach() instead
3648
	// TODO remove after the deprecation release
3649
	protected final void onBeginRequest()
3652
	}
Processes the component tag.

Parameters:
tag Tag to modify
3660
	protected void onComponentTag(final ComponentTag tag)
3662
		// We can't try to get the ID from markup. This could be different than
3663
		// id returned from getMarkupId() prior first rendering the component
3664
		// (due to transparent resolvers and borders which break the 1:1
3665
		// component <-> markup relation)
3670
	}
Processes the body.

Parameters:
markupStream The markup stream
openTag The open tag for the body
3680
	protected void onComponentTagBody(final MarkupStream markupStream, final ComponentTag openTag)
3682
	}
Called to allow a component to detach resources after use. Overrides of this method MUST call the super implementation, the most logical place to do this is the last line of the override method. 
3692
	protected void onDetach()
3696
	}

Deprecated:
use onDetach() instead
3701
	// TODO remove after the deprecation release
3702
	protected final void onEndRequest()
3705
	}
Called anytime a model is changed after the change has occurred 
3710
	protected void onModelChanged()
3712
	}
Called anytime a model is changed, but before the change actually occurs 
3717
	protected void onModelChanging()
3719
	}
Implementation that renders this component.

Parameters:
markupStream
Since:
Wicket 1.2
3727
	protected abstract void onRender(final MarkupStream markupStream);
Writes a simple tag out to the response stream. Any components that might be referenced by the tag are ignored. Also undertakes any tag attribute modifications if they have been added to the component.

Parameters:
tag The tag to write
3737
	protected final void renderComponentTag(ComponentTag tag)
3739
		final boolean ajaxRequest = getRequest() instanceof WebRequest &&
3742
		final boolean stripWicketTags = ajaxRequest ||
3745
		if (!(tag instanceof WicketTag) || !stripWicketTags)
3747
			// Apply behavior modifiers
3748
			List behaviors = getBehaviorsImpl();
3749
			if ((behaviors != null) && !behaviors.isEmpty() && !tag.isClose() &&
3752
				tag = tag.mutable();
3754
				for (Iterator i = behaviors.iterator(); i.hasNext();)
3756
					IBehavior behavior = (IBehavior)i.next();
3758
					// Components may reject some behavior components
3759
					if (isBehaviorAccepted(behavior))
3761
						behavior.onComponentTag(this, tag);
3766
			// apply behaviors that are attached to the component tag.
3767
			if (tag.hasBehaviors())
3769
				Iterator tagBehaviors = tag.getBehaviors();
3770
				while (tagBehaviors.hasNext())
3772
					final IBehavior behavior = (IBehavior)tagBehaviors.next();
3773
					behavior.onComponentTag(this, tag);
3777
			// Write the tag
3780
	}
Replaces the body with the given one.

Parameters:
markupStream The markup stream to replace the tag body in
tag The tag
body The new markup
3792
	protected final void replaceComponentTagBody(final MarkupStream markupStream,
3793
		final ComponentTag tag, final CharSequence body)
3795
		// The tag might have been changed from open-close to open. Hence
3796
		// we'll need what was in the markup itself
3797
		ComponentTag markupOpenTag = null;
3799
		// If tag has a body
3800
		if (tag.isOpen())
3802
			// Get what tag was in the markup; not what the user it might
3803
			// have changed it to.
3804
			markupStream.setCurrentIndex(markupStream.getCurrentIndex() - 1);
3805
			markupOpenTag = markupStream.getTag();
3806
			markupStream.next();
3808
			// If it was an open tag in the markup as well, than ...
3809
			if (markupOpenTag.isOpen())
3811
				// skip any raw markup in the body
3812
				markupStream.skipRawMarkup();
3816
		if (body != null)
3818
			// Write the new body
3822
		// If we had an open tag (and not an openclose tag) and we found a
3823
		// close tag, we're good
3824
		if (tag.isOpen())
3826
			// If it was an open tag in the markup, than there must be
3827
			// a close tag as well.
3828
			if ((markupOpenTag != null) && markupOpenTag.isOpen() && !markupStream.atCloseTag())
3830
				// There must be a component in this discarded body
3831
				markupStream.throwMarkupException("Expected close tag for '" + markupOpenTag +
3832
					"' Possible attempt to embed component(s) '" + markupStream.get() +
3833
					"' in the body of this component which discards its body");
3836
	}

Parameters:
auto True to put component into auto-add mode
3842
	protected final void setAuto(final boolean auto)
3845
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!

Parameters:
flag The flag to set
set True to turn the flag on, false to turn it off
3855
	protected final void setFlag(final int flag, final boolean set)
3857
		if (set)
3859
			 |= flag;
3861
		else
3863
			 &= ~flag;
3865
	}
THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!

Parameters:
flag The flag to set
set True to turn the flag on, false to turn it off
3875
	protected final void setFlag(final short flag, final boolean set)
3877
		setFlag((int)flag, set);
3878
	}
If true, all attribute modifiers will be ignored

Parameters:
ignore If true, all attribute modifiers will be ignored
Returns:
This
3887
	protected final Component setIgnoreAttributeModifier(final boolean ignore)
3890
		return this;
3891
	}
The markup stream will be assigned to the component at the beginning of the component render phase. It is temporary working variable only.

Parameters:
markupStream The current markup stream which should be applied by the component to render itself
See also:
findMarkupStream()
MarkupContainer.getMarkupStream()
3904
	protected void setMarkupStream(final MarkupStream markupStream)
3906
	}

Parameters:
model The model to wrap if need be
Returns:
The wrapped model
3913
	protected final IModel wrap(final IModel model)
3915
		if (model instanceof IComponentAssignedModel)
3919
		else
3921
			return model;
3923
	}
Detaches any child components 
3930
	}
Gets the component at the given path.

Parameters:
path Path to component
Returns:
The component at the path
3939
	Component get(final String path)
3941
		// Path to this component is an empty path
3942
		if (path.equals(""))
3944
			return this;
3947
			exceptionMessage("Component is not a container and so does " + "not contain the path " +
3948
				path));
3949
	}
Checks whether or not this component has a markup id value generated, whether it is automatic or user defined

Returns:
true if this component has a markup id value generated
3957
	final boolean hasMarkupIdMetaData()
3959
		return getMarkupId() != null;
3966
	}

Returns:
True if this component or any of its parents is in auto-add mode
3971
	final boolean isAuto()
3973
		// Search up hierarchy for FLAG_AUTO
3974
		for (Component current = this; current != null; current = current.getParent())
3976
			if (current.getFlag())
3978
				return true;
3981
		return false;
3991
	}
This method is here for MarkupContainer. It is broken out of onBeforeRender() so we can guarantee that it executes as the last in onBeforeRender() chain no matter where user places the super.onBeforeRender() call. 
4001
	}
Renders the close tag at the current position in the markup stream.

Parameters:
markupStream the markup stream
openTag the tag to render
renderTagOnly if true, the tag will not be written to the output
4013
	final void renderClosingComponentTag(final MarkupStream markupStream,
4014
		final ComponentTag openTag, final boolean renderTagOnly)
4016
		// Tag should be open tag and not openclose tag
4017
		if (openTag.isOpen())
4019
			// If we found a close tag and it closes the open tag, we're good
4020
			if (markupStream.atCloseTag() && markupStream.getTag().closes(openTag))
4022
				// Get the close tag from the stream
4023
				ComponentTag closeTag = markupStream.getTag();
4025
				// If the open tag had its id changed
4026
				if (openTag.getNameChanged())
4028
					// change the id of the close tag
4029
					closeTag = closeTag.mutable();
4030
					closeTag.setName(openTag.getName());
4033
				// Render the close tag
4034
				if (renderTagOnly == false)
4038
				markupStream.next();
4040
			else
4042
				if (openTag.requiresCloseTag())
4044
					// Missing close tag
4045
					markupStream.throwMarkupException("Expected close tag for " + openTag);
4049
	}
Sets the id of this component. This method is private because the only time a component's id can be set is in its constructor.

Parameters:
id The non-null id of this component
4058
	final void setId(final String id)
4060
		if (id == null && !(this instanceof Page))
4062
			throw new WicketRuntimeException("Null component id is not allowed.");
4064
		this. = id;
4065
	}
Sets the parent of a component.

Parameters:
parent The parent container
4073
	final void setParent(final MarkupContainer parent)
4075
		if (this. != null && .isDebugEnabled())
4077
			.debug("Replacing parent " + this. + " with " + parent);
4079
		this. = parent;
4080
	}
Sets the render allowed flag.

Parameters:
renderAllowed
4087
	final void setRenderAllowed(boolean renderAllowed)
4090
	}
Sets the render allowed flag. Visit all this page's children (overridden in MarkupContainer) to check rendering authorization, as appropriate. We set any result; positive or negative as a temporary boolean in the components, and when a authorization exception is thrown it will block the rendering of this page
New to GrepCode? Check out our FAQ X