org.apache.wicket.markup.html.link
Class AbstractLink

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.link.AbstractLink
All Implemented Interfaces:
Serializable, IClusterable, IConverterLocator
Direct Known Subclasses:
AbstractSubmitLink, AjaxLink, ExternalLink, Link

public abstract class AbstractLink
extends WebMarkupContainer

Base class that that contains functionality for rendering disabled links.

Author:
Matej Knopp
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.wicket.Component
Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange
 
Field Summary
 
Fields inherited from class org.apache.wicket.Component
ENABLE, FLAG_CONFIGURED, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER
 
Constructor Summary
AbstractLink(String id)
          Construct.
AbstractLink(String id, IModel<?> model)
          Construct.
 
Method Summary
protected  void disableLink(ComponentTag tag)
          Alters the tag so that the link renders as disabled.
 String getAfterDisabledLink()
          Gets the insertion string to allow disabled links to look like Disabled link .
 String getBeforeDisabledLink()
          Gets the insertion string to allow disabled links to look like Disabled link .
protected  boolean isLinkEnabled()
          Helper methods that both checks whether the link is enabled and whether the action ENABLE is allowed.
protected  void onBeforeRender()
          Called just before a component is rendered.
protected  void onComponentTagBody(MarkupStream markupStream, ComponentTag openTag)
          Renders this link's body.
 AbstractLink setAfterDisabledLink(String afterDisabledLink)
          Sets the insertion string to allow disabled links to look like Disabled link .
 AbstractLink setBeforeDisabledLink(String beforeDisabledLink)
          Sets the insertion string to allow disabled links to look like Disabled link .
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getMarkupType, getWebPage, getWebRequest
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeginRequest, onComponentTag, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AbstractLink

public AbstractLink(String id,
                    IModel<?> model)
Construct.

Parameters:
id -
model -

AbstractLink

public AbstractLink(String id)
Construct.

Parameters:
id -
Method Detail

setAfterDisabledLink

public AbstractLink setAfterDisabledLink(String afterDisabledLink)
Sets the insertion string to allow disabled links to look like Disabled link .

Parameters:
afterDisabledLink - The insertion string
Returns:
this

getAfterDisabledLink

public String getAfterDisabledLink()
Gets the insertion string to allow disabled links to look like Disabled link .

Returns:
The insertion string

setBeforeDisabledLink

public AbstractLink setBeforeDisabledLink(String beforeDisabledLink)
Sets the insertion string to allow disabled links to look like Disabled link .

Parameters:
beforeDisabledLink - The insertion string
Returns:
this

onBeforeRender

protected void onBeforeRender()
Description copied from class: Component
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 Component.onBeforeRender() call to its children it is strongly recommended that super call is made at the end of the override.

Overrides:
onBeforeRender in class Component
See Also:
Component.callOnBeforeRenderIfNotVisible()

getBeforeDisabledLink

public String getBeforeDisabledLink()
Gets the insertion string to allow disabled links to look like Disabled link .

Returns:
The insertion string

isLinkEnabled

protected final boolean isLinkEnabled()
Helper methods that both checks whether the link is enabled and whether the action ENABLE is allowed.

Returns:
whether the link should be rendered as enabled

onComponentTagBody

protected void onComponentTagBody(MarkupStream markupStream,
                                  ComponentTag openTag)
Renders this link's body.

Overrides:
onComponentTagBody in class MarkupContainer
Parameters:
markupStream - the markup stream
openTag - the open part of this tag
See Also:
Component.onComponentTagBody(MarkupStream, ComponentTag)

disableLink

protected void disableLink(ComponentTag tag)
Alters the tag so that the link renders as disabled. This method is meant to be called from Component.onComponentTag(ComponentTag) method of the derived class.

Parameters:
tag -


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.