| |
|
| java.lang.Object org.apache.wicket.Component
All known Subclasses: org.apache.wicket.guice.TestComponent, org.apache.wicket.markup.html.WebComponent, org.apache.wicket.resource.DummyComponent, org.apache.wicket.MarkupContainer,
Component | abstract public class Component implements IClusterable,IConverterLocator(Code) | | 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
Component.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
Component.getRequestCycle . The convenience methods
Component.getRequest ,
Component.getResponse and
Component.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
Component.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
Component.render , which calls subclass implementation code
contained in
Component.onRender . Once this phase begins, a
Component becomes immutable. Attempts to alter the Component will result in a
WicketRuntimeException.
- onEndRequest () - The
Component.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
Component.setModel(IModel model) and retrieved via
Component.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
Component.getModelObject is provided to retrieve the model Object
from its IModel wrapper. A further convenience method,
Component.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
Component.getPage . If the Component is not attached to
a Page, an IllegalStateException will be thrown. An equivalent method,
Component.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
Component.getLocalizer . The convenience methods
Component.getString(String key) and
Component.getString(String keyIModel model) wrap the identical
methods on the Application Localizer for easy access in Components.
- Style - The style ("skin") for a component is available through
Component.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
AttributeModifier s 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
Component.debug(String) ,
Component.info(String) ,
Component.warn(String) ,
Component.error(String) and
Component.fatal(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
Component.getFeedbackMessage .
- Page Factory - It is possible to change the way that Pages are
constructed by overriding the
Component.getPageFactory method,
returning your own implementation of
org.apache.wicket.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
Component.setVersioned(boolean) method. The
versioning participation of a given Component can be retrieved with
Component.isVersioned .
- AJAX support- Components can be re-rendered after the whole Page
has been rendered at least once by calling doRender().
author: Jonathan Locke author: Chris Turner author: Eelco Hillenius author: Johan Compagner author: Juergen Donnerstag author: Igor Vaynberg (ivaynberg) |
Inner Class :public class ComponentModelChange extends Change | |
Inner Class :public static interface IVisitor | |
Inner Class :final protected static class EnabledChange extends Change | |
Inner Class :final protected static class VisibilityChange extends Change | |
Method Summary | |
public Component | add(IBehavior behavior) Adds an behavior modifier to the component. | final protected void | addStateChange(Change change) Adds state change to page. | final public void | afterRender() Called on very component after the page is renderd It will call
onAfterRender for it self and its childeren. | final public void | attach() Attaches the component. | final public void | beforeRender() Called for every component when the page is getting to be rendered. | final protected void | checkComponentTag(ComponentTag tag, String name) Checks whether the given type has the expected name. | final protected void | checkComponentTagAttribute(ComponentTag tag, String key, String value) Checks that a given tag has a required attribute value. | protected void | checkHierarchyChange(Component component) Checks whether the hierarchy may be changed at all, and throws an
exception if this is not the case. | final public boolean | continueToOriginalDestination() Redirects to any intercept page previously specified by a call to
redirectToInterceptPage. | final public void | debug(String message) | final public void | detach() Detaches the component. | final public void | detachBehaviors() THIS IS WICKET INTERNAL ONLY. | void | detachChildren() | protected void | detachModel() Detaches the model for this component if it is detachable. | public void | detachModels() | final public void | error(Serializable message) | final protected String | exceptionMessage(String message) Prefixes an exception message with useful information about this. | final public void | fatal(String message) | protected MarkupStream | findMarkupStream() Finds the markup stream for this component.
The markup stream for this component. | final protected Page | findPage() If this Component is a Page, returns self. | final public MarkupContainer | findParent(Class c) Finds the first container parent of this component of the given class. | final public MarkupContainer | findParentWithAssociatedMarkup() | Component | get(String path) Gets the component at the given path. | final public Application | getApplication() Gets interface to application that this component is a part of. | final public List | getBehaviors() Gets the currently coupled
IBehavior s as a unmodifiable list. | protected List | getBehaviors(Class type) Gets the subset of the currently coupled
IBehavior s that are of
the provided type as a unmodifiable list or null if there are no
behaviors attached. | final public String | getClassRelativePath() | final public IComponentBorder | getComponentBorder() | final public IConverter | getConverter() nothing, will always throw an exception. | public IConverter | getConverter(Class type) Gets the converter that should be used by this component. | final public boolean | getEscapeModelStrings() Gets whether model strings should be escaped. | final public FeedbackMessage | getFeedbackMessage() | final protected boolean | getFlag(int flag) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | final protected boolean | getFlag(short flag) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | public String | getId() Gets the id of this component. | final public IModel | getInnermostModel() | final protected IModel | getInnermostModel(IModel model) Finds the innermost IModel object for an IModel that might contain nested
IModel(s). | public Locale | getLocale() Gets the locale for this component. | final public Localizer | getLocalizer() Convenience method to provide easy access to the localizer object within
any component. | final public ValueMap | getMarkupAttributes() THIS IS WICKET INTERNAL ONLY. | public String | getMarkupId() Retrieves id by which this component is represented within the markup.
This is either the id attribute set explicitly via a call to
Component.setMarkupId(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. | final public Serializable | getMetaData(MetaDataKey key) Gets metadata for this component using the given key. | final public IModel | getModel() Gets the model. | protected IModelComparator | getModelComparator() Gets the value defaultModelComparator. | final public Object | getModelObject() Gets the backing model object; this is shorthand for
getModel().getObject(). | final public String | getModelObjectAsString() Gets a model object as a string. | final public String | getModelObjectAsString(Object modelObject) | final public boolean | getOutputMarkupId() Gets whether or not component will output id attribute into the markup. | final public Page | getPage() Gets the page holding this component. | final public IPageFactory | getPageFactory() | final public String | getPageRelativePath() Gets the path to this component relative to the page it is in. | final public MarkupContainer | getParent() Gets any parent container, or null if there is none. | final public String | getPath() Gets this component's path. | final public boolean | getRenderBodyOnly() If false the component's tag will be printed as well as its body (which
is default). | final public Request | getRequest() | final public RequestCycle | getRequestCycle() | final public Response | getResponse() | public Session | getSession() Gets the current Session object. | public long | getSizeInBytes() | protected boolean | getStatelessHint() Returns whether the component can be stateless. | final public String | getString(String key) | final public String | getString(String key, IModel model) | final public String | getString(String key, IModel model, String defaultValue) | final public String | getStyle() Gets the style of this component (see
org.apache.wicket.Session ). | public String | getVariation() Gets the variation string of this component that will be used to look up
markup for this component. | final public boolean | hasBeenRendered() Gets whether this component was rendered at least once. | final public boolean | hasErrorMessage() | final public boolean | hasFeedbackMessage() | final boolean | hasMarkupIdMetaData() | final public void | info(String message) | protected IModel | initModel() Called when a null model is about to be retrieved in order to allow a
subclass to provide an initial model. | final public void | internalAttach() | void | internalAttach2() Attaches any child components
This method is here only for
MarkupContainer . | final public void | internalDetach() | void | internalMarkRendering() | final protected void | internalOnAttach() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | final protected void | internalOnDetach() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | protected void | internalOnModelChanged() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | final public boolean | isActionAuthorized(Action action) Authorizes an action for a component. | final public boolean | isAncestorOf(Component component) | final protected boolean | isAttached() | final boolean | isAuto() | protected boolean | isBehaviorAccepted(IBehavior behavior) Components are allowed to reject behavior modifiers. | final public boolean | isEnableAllowed() | public boolean | isEnabled() Gets whether this component is enabled. | final protected boolean | isIgnoreAttributeModifier() | boolean | isPreparedForRender() | final public boolean | isRenderAllowed() | final public boolean | isStateless() Returns if the component is stateless or not. | public boolean | isVersioned() | public boolean | isVisible() Gets whether this component and any children are visible.
WARNING: this method can be called multiple times during a request. | final public boolean | isVisibleInHierarchy() Checks if the component itself and all its parents are visible. | protected MarkupStream | locateMarkupStream() | final public void | markRendering() Sets the RENDERING flag on component and it's children. | final public void | modelChanged() | final public void | modelChanging() | final public Page | newPage(Class c) | final public Page | newPage(Class c, PageParameters parameters) | protected void | onAfterRender() Called just after a component is rendered. | void | onAfterRenderChildren() | protected void | onAttach() Called to allow a component to attach resources for use. | protected void | onBeforeRender() Called just before a component is rendered. | void | onBeforeRenderChildren() This method is here for
MarkupContainer . | final protected void | onBeginRequest() | protected void | onComponentTag(ComponentTag tag) Processes the component tag. | protected void | onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Processes the body. | protected void | onDetach() Called to allow a component to detach resources after use. | final protected void | onEndRequest() | protected void | onModelChanged() | protected void | onModelChanging() | abstract protected void | onRender(MarkupStream markupStream) Implementation that renders this component. | public void | prepareForRender() Prepares the component and it's children for rendering. | final public void | redirectToInterceptPage(Page page) Redirects browser to an intermediate page such as a sign-in page. | final public void | remove() Removes this component from its parent. | public Component | remove(IBehavior behavior) | final public void | render() Performs a render of this component as part of a Page level render
process.
For component level re-render (e.g. | final public void | render(MarkupStream markupStream) Performs a render of this component as part of a Page level render
process.
For component level re-render (e.g. | final void | renderClosingComponentTag(MarkupStream markupStream, ComponentTag openTag, boolean renderTagOnly) Renders the close tag at the current position in the markup stream. | final public void | renderComponent() Page.renderPage() is used to render a whole page. | final public void | renderComponent(MarkupStream markupStream) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | final protected void | renderComponentTag(ComponentTag tag) Writes a simple tag out to the response stream. | public void | renderHead(HtmlHeaderContainer container) Print to the web response what ever the component wants to contribute to
the head section. | final public void | rendered() Called to indicate that a component has been rendered. | final protected void | replaceComponentTagBody(MarkupStream markupStream, ComponentTag tag, CharSequence body) Replaces the body with the given one. | public void | replaceWith(Component replacement) Replaces this component with another. | final public boolean | sameInnermostModel(Component component) | final public boolean | sameInnermostModel(IModel model) | final protected void | setAuto(boolean auto) | final public Component | setComponentBorder(IComponentBorder border) Assigns a component border to this component. | final public Component | setEnabled(boolean enabled) Sets whether this component is enabled. | final public Component | setEscapeModelStrings(boolean escapeMarkup) Sets whether model strings should be escaped. | final protected void | setFlag(int flag, boolean set) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | final protected void | setFlag(short flag, boolean set) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. | final void | setId(String id) Sets the id of this component. | final protected Component | setIgnoreAttributeModifier(boolean ignore) | public void | setMarkupId(String markupId) Sets this component's markup id to a user defined value. | protected void | setMarkupStream(MarkupStream markupStream) The markup stream will be assigned to the component at the beginning of
the component render phase. | final public void | setMetaData(MetaDataKey key, Serializable object) Sets the metadata for this component using the given key. | public Component | setModel(IModel model) Sets the given model.
WARNING: DO NOT OVERRIDE THIS METHOD UNLESS YOU HAVE A VERY GOOD REASON
FOR IT. | final public Component | setModelObject(Object object) Sets the backing model object; shorthand for
getModel().setObject(object). | final public Component | setOutputMarkupId(boolean output) Sets whether or not component will output id attribute into the markup.
id attribute will be set to the value returned from
Component.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 asthe component. | final public Component | setOutputMarkupPlaceholderTag(boolean outputTag) Render a placeholder tag when the component is not visible. | final void | setParent(MarkupContainer parent) Sets the parent of a component. | final public void | setRedirect(boolean redirect) | final void | setRenderAllowed(boolean renderAllowed) Sets the render allowed flag. | final public Component | setRenderBodyOnly(boolean renderTag) If false the component's tag will be printed as well as its body (which
is default). | final public void | setResponsePage(Class cls) | final public void | setResponsePage(Class cls, PageParameters parameters) | final public void | setResponsePage(Page page) | public Component | setVersioned(boolean versioned) Parameters: versioned - True to turn on versioning for this component, false to turnit off for this component and any children. | final public Component | setVisible(boolean visible) Sets whether this component and any children are visible. | public String | toString() Gets the string representation of this component. | public String | toString(boolean detailed) | final public CharSequence | urlFor(Class pageClass, PageParameters parameters) Returns a bookmarkable URL that references a given page class using a
given set of page parameters. | final public CharSequence | urlFor(IBehavior behaviour, RequestListenerInterface listener) Gets a URL for the listener interface on a behaviour (e.g. | final public CharSequence | urlFor(IPageMap pageMap, Class pageClass, PageParameters parameters) Returns a bookmarkable URL that references a given page class using a
given set of page parameters. | final public CharSequence | urlFor(IRequestTarget requestTarget) Returns a URL that references the given request target. | final public CharSequence | urlFor(RequestListenerInterface listener) Gets a URL for the listener interface (e.g. | final public CharSequence | urlFor(ResourceReference resourceReference) Returns a URL that references a shared resource through the provided
resource reference. | final public Object | visitParents(Class c, IVisitor visitor) Traverses all parent components of the given class in this container,
calling the visitor's visit method at each one. | final public void | warn(String message) Registers a warning feedback message for this component. | final protected IModel | wrap(IModel model) |
ADDED_AT_KEY | final static MetaDataKey ADDED_AT_KEY(Code) | | Meta data key for line precise error logging for the moment of addition.
Made package private for access in
MarkupContainer and
Page |
CONSTRUCTED_AT_KEY | final static MetaDataKey CONSTRUCTED_AT_KEY(Code) | | meta data key for line precise error logging for the moment of
construction. Made package private for access in
Page |
ENABLE | final public static Action ENABLE(Code) | | 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.
|
FLAG_ATTACHED | final static int FLAG_ATTACHED(Code) | | |
FLAG_ATTACHING | final static int FLAG_ATTACHING(Code) | | |
FLAG_ATTACH_SUPER_CALL_VERIFIED | final static int FLAG_ATTACH_SUPER_CALL_VERIFIED(Code) | | |
FLAG_PREPARED_FOR_RENDER | final static int FLAG_PREPARED_FOR_RENDER(Code) | | Flag that makes we are in before-render callback phase Set after
component.onBeforeRender is invoked (right before invoking beforeRender
on children)
|
FLAG_RESERVED1 | final protected static int FLAG_RESERVED1(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED2 | final protected static int FLAG_RESERVED2(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED3 | final protected static int FLAG_RESERVED3(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED4 | final protected static int FLAG_RESERVED4(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED5 | final protected static int FLAG_RESERVED5(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED6 | final protected static int FLAG_RESERVED6(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED7 | final protected static int FLAG_RESERVED7(Code) | | Reserved subclass-definable flag bit
|
FLAG_RESERVED8 | final protected static int FLAG_RESERVED8(Code) | | Reserved subclass-definable flag bit
|
PATH_SEPARATOR | final public static char PATH_SEPARATOR(Code) | | Separator for component paths
|
RENDER | final public static Action RENDER(Code) | | 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
AuthorizationException , which will
then be handled further by the framework.
|
markupIndex | int markupIndex(Code) | | 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
|
Component | public Component(String id)(Code) | | 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. |
Component | public Component(String id, IModel model)(Code) | | 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 Parameters: model - The component's model throws: WicketRuntimeException - Thrown if the component has been given a null id. |
add | public Component add(IBehavior behavior)(Code) | | 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 this (to allow method call chaining) |
addStateChange | final protected void addStateChange(Change change)(Code) | | Adds state change to page.
Parameters: change - The change |
afterRender | final public void afterRender()(Code) | | Called on very component after the page is renderd It will call
onAfterRender for it self and its childeren.
|
attach | final public void attach()(Code) | | Attaches the component. This is called when the page is starting to be
used for rendering or when a component listener call is executed on it.
|
beforeRender | final public void beforeRender()(Code) | | Called for every component when the page is getting to be rendered. it
will call onBeforeRender for this component and all the child components
|
checkComponentTag | final protected void checkComponentTag(ComponentTag tag, String name)(Code) | | Checks whether the given type has the expected name.
Parameters: tag - The tag to check Parameters: name - The expected tag name throws: MarkupException - Thrown if the tag is not of the right name |
checkComponentTagAttribute | final protected void checkComponentTagAttribute(ComponentTag tag, String key, String value)(Code) | | Checks that a given tag has a required attribute value.
Parameters: tag - The tag Parameters: key - The attribute key Parameters: value - The required value for the attribute key throws: MarkupException - Thrown if the tag does not have the required attribute value |
checkHierarchyChange | protected void checkHierarchyChange(Component component)(Code) | | 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 |
continueToOriginalDestination | final public boolean continueToOriginalDestination()(Code) | | Redirects to any intercept page previously specified by a call to
redirectToInterceptPage.
True if an original destination was redirected to See Also: Component.redirectToInterceptPage(Page) |
debug | final public void debug(String message)(Code) | | Registers a debug feedback message for this component
Parameters: message - The feedback message |
detach | final public void detach()(Code) | | Detaches the component. This is called at the end of the request for all
the pages that are touched in that request.
|
detachBehaviors | final public void detachBehaviors()(Code) | | 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
AjaxRequestTarget to be able to cleanup component's behaviors
after header contribution has been done (which is separated from
component render).
|
detachModel | protected void detachModel()(Code) | | Detaches the model for this component if it is detachable.
|
detachModels | public void detachModels()(Code) | | Detaches all models
|
error | final public void error(Serializable message)(Code) | | Registers an error feedback message for this component
Parameters: message - The feedback message |
exceptionMessage | final protected String exceptionMessage(String message)(Code) | | Prefixes an exception message with useful information about this.
component.
Parameters: message - The message The modified message |
fatal | final public void fatal(String message)(Code) | | Registers an fatal error feedback message for this component
Parameters: message - The feedback message |
findMarkupStream | protected MarkupStream findMarkupStream()(Code) | | Finds the markup stream for this component.
The markup stream for this component. Since a Component cannothave a markup stream, we ask this component's parent to searchfor it. |
findPage | final protected Page findPage()(Code) | | 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.
The Page or null if none can be found |
findParent | final public MarkupContainer findParent(Class c)(Code) | | Finds the first container parent of this component of the given class.
Parameters: c - MarkupContainer class to search for First container parent that is an instance of the given class, ornull if none can be found |
findParentWithAssociatedMarkup | final public MarkupContainer findParentWithAssociatedMarkup()(Code) | | The nearest markup container with associated markup |
get | Component get(String path)(Code) | | Gets the component at the given path.
Parameters: path - Path to component The component at the path |
getApplication | final public Application getApplication()(Code) | | Gets interface to application that this component is a part of.
The application associated with the session that this componentis in. See Also: Application |
getBehaviors | final public List getBehaviors()(Code) | | Gets the currently coupled
IBehavior s as a unmodifiable list.
Returns an empty list rather than null if there are no behaviors coupled
to this component.
The currently coupled behaviors as a unmodifiable list |
getBehaviors | protected List getBehaviors(Class type)(Code) | | Gets the subset of the currently coupled
IBehavior s 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 The subset of the currently coupled behaviors that are of theprovided type as a unmodifiable list or null |
getComponentBorder | final public IComponentBorder getComponentBorder()(Code) | | component border assigned to this component, or null if none |
getConverter | public IConverter getConverter(Class type)(Code) | | Gets the converter that should be used by this component.
Parameters: type - The type to convert to The converter that should be used by this component |
getEscapeModelStrings | final public boolean getEscapeModelStrings()(Code) | | Gets whether model strings should be escaped.
Returns whether model strings should be escaped |
getFeedbackMessage | final public FeedbackMessage getFeedbackMessage()(Code) | | Any feedback message for this component |
getFlag | final protected boolean getFlag(int flag)(Code) | | THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!
Parameters: flag - The flag to test True if the flag is set |
getFlag | final protected boolean getFlag(short flag)(Code) | | THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!
Parameters: flag - The flag to test True if the flag is set |
getId | public String getId()(Code) | | Gets the id of this component.
The id of this component |
getInnermostModel | final public IModel getInnermostModel()(Code) | | Innermost model for this component |
getInnermostModel | final protected IModel getInnermostModel(IModel model)(Code) | | Finds the innermost IModel object for an IModel that might contain nested
IModel(s).
Parameters: model - The model The innermost (most nested) model |
getLocale | public Locale getLocale()(Code) | | Gets the locale for this component. By default, it searches it parent for
a locale. If no parents (it's a recursive search) returns a locale, it
gets one from the session.
The locale to be used for this component See Also: Session.getLocale |
getLocalizer | final public Localizer getLocalizer()(Code) | | Convenience method to provide easy access to the localizer object within
any component.
The localizer object |
getMarkupAttributes | final public ValueMap getMarkupAttributes()(Code) | | 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).
markup attributes |
getMarkupId | public String getMarkupId()(Code) | | Retrieves id by which this component is represented within the markup.
This is either the id attribute set explicitly via a call to
Component.setMarkupId(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.
markup id of the component |
getMetaData | final public Serializable getMetaData(MetaDataKey key)(Code) | | Gets metadata for this component using the given key.
Parameters: key - The key for the data The metadata or null of no metadata was found for the given key See Also: MetaDataKey |
getModel | final public IModel getModel()(Code) | | Gets the model. It returns the object that wraps the backing model.
The model |
getModelComparator | protected IModelComparator getModelComparator()(Code) | | 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.
the value defaultModelComparator |
getModelObject | final public Object getModelObject()(Code) | | Gets the backing model object; this is shorthand for
getModel().getObject().
The backing model object |
getModelObjectAsString | final public String getModelObjectAsString()(Code) | | Gets a model object as a string.
Model object for this component as a string |
getModelObjectAsString | final public String getModelObjectAsString(Object modelObject)(Code) | | Parameters: modelObject - Model object to convert to string The string |
getOutputMarkupId | final public boolean getOutputMarkupId()(Code) | | Gets whether or not component will output id attribute into the markup.
id attribute will be set to the value returned from
Component.getMarkupId .
whether or not component will output id attribute into the markup |
getPage | final public Page getPage()(Code) | | Gets the page holding this component.
The page holding this component throws: IllegalStateException - Thrown if component is not yet attached to a Page. |
getPageFactory | final public IPageFactory getPageFactory()(Code) | | The page factory for the session that this component is in |
getPageRelativePath | final public String getPageRelativePath()(Code) | | Gets the path to this component relative to the page it is in.
The path to this component relative to the page it is in |
getParent | final public MarkupContainer getParent()(Code) | | Gets any parent container, or null if there is none.
Any parent container, or null if there is none |
getPath | final public String getPath()(Code) | | Gets this component's path.
Colon separated path to this component in the component hierarchy |
getRenderBodyOnly | final public boolean getRenderBodyOnly()(Code) | | 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.
If true, the component tag will not be printed |
getRequest | final public Request getRequest()(Code) | | The request for this component's active request cycle |
getRequestCycle | final public RequestCycle getRequestCycle()(Code) | | Gets the active request cycle for this component
The request cycle |
getResponse | final public Response getResponse()(Code) | | The response for this component's active request cycle |
getSession | public Session getSession()(Code) | | Gets the current Session object.
The Session that this component is in |
getSizeInBytes | public long getSizeInBytes()(Code) | | Size of this Component in bytes |
getStatelessHint | protected boolean getStatelessHint()(Code) | | Returns whether the component can be stateless. Being able to be
stateless doesn't necessary mean, that the component should be stateless.
Whether the component should be stateless depends on
whether the component can be stateless |
getString | final public String getString(String key)(Code) | | Parameters: key - Key of string resource in property file The String See Also: Localizer |
getString | final public String getString(String key, IModel model)(Code) | | Parameters: key - The resource key Parameters: model - The model The formatted string See Also: Localizer |
getString | final public String getString(String key, IModel model, String defaultValue)(Code) | | Parameters: key - The resource key Parameters: model - The model Parameters: defaultValue - A default value if the string cannot be found The formatted string See Also: Localizer |
getVariation | public String getVariation()(Code) | | 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.
The variation of this component. |
hasBeenRendered | final public boolean hasBeenRendered()(Code) | | Gets whether this component was rendered at least once.
true if the component has been rendered before, false if it ismerely constructed |
hasErrorMessage | final public boolean hasErrorMessage()(Code) | | True if this component has an error message |
hasFeedbackMessage | final public boolean hasFeedbackMessage()(Code) | | True if this component has some kind of feedback message |
hasMarkupIdMetaData | final boolean hasMarkupIdMetaData()(Code) | | Checks whether or not this component has a markup id value generated,
whether it is automatic or user defined
true if this component has a markup id value generated |
info | final public void info(String message)(Code) | | Registers an informational feedback message for this component
Parameters: message - The feedback message |
initModel | protected IModel initModel()(Code) | | 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.
The model |
internalAttach | final public void internalAttach()(Code) | | |
internalAttach2 | void internalAttach2()(Code) | | Attaches any child components
This method is here only for
MarkupContainer . It is broken out
of
Component.onBeforeRender() so we can guarantee that it executes as the
last in onAttach() chain no matter where user places the
super.onAttach() call
|
internalDetach | final public void internalDetach()(Code) | | |
internalMarkRendering | void internalMarkRendering()(Code) | | |
internalOnAttach | final protected void internalOnAttach()(Code) | | THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR
OVERRIDE.
Called when a request begins.
Component.onBeforeRender() |
internalOnDetach | final protected void internalOnDetach()(Code) | | THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR
OVERRIDE.
Called when a request ends.
Component.onBeforeRender() |
internalOnModelChanged | protected void internalOnModelChanged()(Code) | | 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.
|
isActionAuthorized | final public boolean isActionAuthorized(Action action)(Code) | | Authorizes an action for a component.
Parameters: action - The action to authorize True if the action is allowed throws: AuthorizationException - Can be thrown by implementation if action is unauthorized |
isAncestorOf | final public boolean isAncestorOf(Component component)(Code) | | Returns true if this component is an ancestor of the given component
Parameters: component - The component to check True if the given component has this component as an ancestor |
isAttached | final protected boolean isAttached()(Code) | | true if this component is attached |
isAuto | final boolean isAuto()(Code) | | True if this component or any of its parents is in auto-add mode |
isBehaviorAccepted | protected boolean isBehaviorAccepted(IBehavior behavior)(Code) | | Components are allowed to reject behavior modifiers.
Parameters: behavior - False, if the component should not apply this behavior |
isEnableAllowed | final public boolean isEnableAllowed()(Code) | | true if this component is authorized to be enabled, falseotherwise |
isEnabled | public boolean isEnabled()(Code) | | 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.
Whether this component is enabled. |
isIgnoreAttributeModifier | final protected boolean isIgnoreAttributeModifier()(Code) | | If true, all attribute modifiers will be ignored
True, if attribute modifiers are to be ignored |
isPreparedForRender | boolean isPreparedForRender()(Code) | | |
isRenderAllowed | final public boolean isRenderAllowed()(Code) | | Checks the security strategy if the
Component.RENDER action is
allowed on this component
ture if Component.RENDER action is allowed, falseotherwise |
isStateless | final public boolean isStateless()(Code) | | 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 behaviours if they can be stateless.
whether the component is stateless. |
isVersioned | public boolean isVersioned()(Code) | | True if this component is versioned |
isVisible | public boolean isVisible()(Code) | | 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
Component.setVisible(boolean) .
True if component and any children are visible |
isVisibleInHierarchy | final public boolean isVisibleInHierarchy()(Code) | | Checks if the component itself and all its parents are visible.
true if the component and all its parents are visible. |
locateMarkupStream | protected MarkupStream locateMarkupStream()(Code) | | Component's markup stream |
markRendering | final public void markRendering()(Code) | | Sets the RENDERING flag on component and it's children.
|
modelChanged | final public void modelChanged()(Code) | | Called to indicate that the model content for this component has been
changed
|
modelChanging | final public void modelChanging()(Code) | | Called to indicate that the model content for this component is about to
change
|
newPage | final public Page newPage(Class c)(Code) | | Creates a new page using the component's page factory
Parameters: c - The class of page to create The new page |
newPage | final public Page newPage(Class c, PageParameters parameters)(Code) | | Creates a new page using the component's page factory
Parameters: c - The class of page to create Parameters: parameters - Any parameters to pass to the constructor The new page |
onAfterRender | protected void onAfterRender()(Code) | | Called just after a component is rendered.
|
onAfterRenderChildren | void onAfterRenderChildren()(Code) | | |
onAttach | protected void onAttach()(Code) | | Called to allow a component to attach resources for use.
Overrides of this method MUST call the super implementation, the most
logical place to do this is the first line of the override method.
|
onBeforeRender | protected void onBeforeRender()(Code) | | Called just before a component is rendered. If you override this, you
must* call super.onBeforeRender() within your implementation.
|
onBeforeRenderChildren | void onBeforeRenderChildren()(Code) | | This method is here for
MarkupContainer . It is broken out of
Component.onBeforeRender() so we can guarantee that it executes as the
last in onBeforeRender() chain no matter where user places the
super.onBeforeRender() call.
|
onBeginRequest | final protected void onBeginRequest()(Code) | | |
onComponentTag | protected void onComponentTag(ComponentTag tag)(Code) | | Processes the component tag.
Parameters: tag - Tag to modify |
onComponentTagBody | protected void onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)(Code) | | Processes the body.
Parameters: markupStream - The markup stream Parameters: openTag - The open tag for the body |
onDetach | protected void onDetach()(Code) | | 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.
|
onEndRequest | final protected void onEndRequest()(Code) | | |
onModelChanged | protected void onModelChanged()(Code) | | Called anytime a model is changed after the change has occurred
|
onModelChanging | protected void onModelChanging()(Code) | | Called anytime a model is changed, but before the change actually occurs
|
onRender | abstract protected void onRender(MarkupStream markupStream)(Code) | | Implementation that renders this component.
since: Wicket 1.2 Parameters: markupStream - |
prepareForRender | public void prepareForRender()(Code) | | 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.
|
redirectToInterceptPage | final public void redirectToInterceptPage(Page page)(Code) | | 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: Component.continueToOriginalDestination |
remove | final public void remove()(Code) | | Removes this component from its parent. It's important to remember that a
component that is removed cannot be referenced from the markup still.
|
remove | public Component remove(IBehavior behavior)(Code) | | Removes behavior from component
Parameters: behavior - behavior to remove this (to allow method call chaining) |
render | final public void render()(Code) | | Performs a render of this component as part of a Page level render
process.
For component level re-render (e.g. AJAX) please call
Component.renderComponent() . Though render() does seem to work, it will
fail for panel children.
|
render | final public void render(MarkupStream markupStream)(Code) | | Performs a render of this component as part of a Page level render
process.
For component level re-render (e.g. AJAX) please call
Component.renderComponent(MarkupStream) . Though render() does seem to
work, it will fail for panel children.
Parameters: markupStream - |
renderClosingComponentTag | final void renderClosingComponentTag(MarkupStream markupStream, ComponentTag openTag, boolean renderTagOnly)(Code) | | Renders the close tag at the current position in the markup stream.
Parameters: markupStream - the markup stream Parameters: openTag - the tag to render Parameters: renderTagOnly - if true, the tag will not be written to the output |
renderComponent | final public void renderComponent()(Code) | | 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).
|
renderComponent | final public void renderComponent(MarkupStream markupStream)(Code) | | 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 |
renderComponentTag | final protected void renderComponentTag(ComponentTag tag)(Code) | | 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 |
rendered | final public void rendered()(Code) | | 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.
|
replaceComponentTagBody | final protected void replaceComponentTagBody(MarkupStream markupStream, ComponentTag tag, CharSequence body)(Code) | | Replaces the body with the given one.
Parameters: markupStream - The markup stream to replace the tag body in Parameters: tag - The tag Parameters: body - The new markup |
replaceWith | public void replaceWith(Component replacement)(Code) | | 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.
since: 1.2.1 Parameters: replacement - component to replace this one |
sameInnermostModel | final public boolean sameInnermostModel(Component component)(Code) | | Parameters: component - The component to compare with True if the given component's model is the same as thiscomponent's model. |
sameInnermostModel | final public boolean sameInnermostModel(IModel model)(Code) | | Parameters: model - The model to compare with True if the given component's model is the same as thiscomponent's model. |
setAuto | final protected void setAuto(boolean auto)(Code) | | Parameters: auto - True to put component into auto-add mode |
setComponentBorder | final public Component setComponentBorder(IComponentBorder border)(Code) | | Assigns a component border to this component. If called with
null any previous border will be cleared.
Parameters: border - componnet border to assign, or null to clearany previous component for chaining |
setEnabled | final public Component setEnabled(boolean enabled)(Code) | | 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 This |
setEscapeModelStrings | final public Component setEscapeModelStrings(boolean escapeMarkup)(Code) | | Sets whether model strings should be escaped.
Parameters: escapeMarkup - True is model strings should be escaped This |
setFlag | final protected void setFlag(int flag, boolean set)(Code) | | THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!
Parameters: flag - The flag to set Parameters: set - True to turn the flag on, false to turn it off |
setFlag | final protected void setFlag(short flag, boolean set)(Code) | | THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!
Parameters: flag - The flag to set Parameters: set - True to turn the flag on, false to turn it off |
setId | final void setId(String id)(Code) | | 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 |
setIgnoreAttributeModifier | final protected Component setIgnoreAttributeModifier(boolean ignore)(Code) | | If true, all attribute modifiers will be ignored
Parameters: ignore - If true, all attribute modifiers will be ignored This |
setMarkupId | public void setMarkupId(String markupId)(Code) | | 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
See Also: Component.getMarkupId() Parameters: markupId - markup id value or null to clear any previous user definedvalue |
setMarkupStream | protected void setMarkupStream(MarkupStream markupStream)(Code) | | The markup stream will be assigned to the component at the beginning of
the component render phase. It is temporary working variable only.
See Also: Component.findMarkupStream() See Also: MarkupContainer.getMarkupStream Parameters: markupStream - The current markup stream which should be applied by thecomponent to render itself |
setMetaData | final public void setMetaData(MetaDataKey key, Serializable object)(Code) | | 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 Parameters: object - The metadata object throws: IllegalArgumentException - See Also: MetaDataKey |
setModel | public Component setModel(IModel model)(Code) | | 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 This |
setModelObject | final public Component setModelObject(Object object)(Code) | | Sets the backing model object; shorthand for
getModel().setObject(object).
Parameters: object - The object to set This |
setOutputMarkupId | final public Component setOutputMarkupId(boolean output)(Code) | | Sets whether or not component will output id attribute into the markup.
id attribute will be set to the value returned from
Component.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 asthe 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 this for chaining |
setOutputMarkupPlaceholderTag | final public Component setOutputMarkupPlaceholderTag(boolean outputTag)(Code) | | 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 - this for chaining |
setParent | final void setParent(MarkupContainer parent)(Code) | | Sets the parent of a component.
Parameters: parent - The parent container |
setRenderAllowed | final void setRenderAllowed(boolean renderAllowed)(Code) | | Sets the render allowed flag.
Parameters: renderAllowed - |
setRenderBodyOnly | final public Component setRenderBodyOnly(boolean renderTag)(Code) | | 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 This |
setVersioned | public Component setVersioned(boolean versioned)(Code) | | Parameters: versioned - True to turn on versioning for this component, false to turnit off for this component and any children. This |
setVisible | final public Component setVisible(boolean visible)(Code) | | Sets whether this component and any children are visible.
Parameters: visible - True if this component and any children should be visible This |
toString | public String toString()(Code) | | Gets the string representation of this component.
The path to this component |
toString | public String toString(boolean detailed)(Code) | | Parameters: detailed - True if a detailed string is desired The string |
urlFor | final public CharSequence urlFor(Class pageClass, PageParameters parameters)(Code) | | 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.
See Also: RequestCycle.urlFor(PageMapClassPageParameters) Parameters: pageClass - Class of page Parameters: parameters - Parameters to page Bookmarkable URL to page |
urlFor | final public CharSequence urlFor(IBehavior behaviour, RequestListenerInterface listener)(Code) | | Gets a URL for the listener interface on a behaviour (e.g.
IBehaviorListener on AjaxPagingNavigationBehavior).
Parameters: behaviour - The behaviour that the URL should point to Parameters: listener - The listener interface that the URL should call The URL |
urlFor | final public CharSequence urlFor(IPageMap pageMap, Class pageClass, PageParameters parameters)(Code) | | 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.
See Also: RequestCycle.urlFor(PageMapClassPageParameters) Parameters: pageMap - Page map to use Parameters: pageClass - Class of page Parameters: parameters - Parameters to page Bookmarkable URL to page |
urlFor | final public CharSequence urlFor(RequestListenerInterface listener)(Code) | | Gets a URL for the listener interface (e.g. ILinkListener).
Parameters: listener - The listener interface that the URL should call The URL |
visitParents | final public Object visitParents(Class c, IVisitor visitor)(Code) | | Traverses all parent components of the given class in this container,
calling the visitor's visit method at each one.
Parameters: c - Class Parameters: visitor - The visitor to call at each parent of the given type First non-null value returned by visitor callback |
warn | final public void warn(String message)(Code) | | Registers a warning feedback message for this component.
Parameters: message - The feedback message |
wrap | final protected IModel wrap(IModel model)(Code) | | Parameters: model - The model to wrap if need be The wrapped model |
|
|
|