A B C D E F G H I L M P Q R S T U

A

AbstractInternalLinkInheritUrlParamLinkPostProcessor - Class in io.wcm.handler.link.processor

Linkhandler postprocessor to inherit URL parametres to internal links.

AbstractInternalLinkInheritUrlParamLinkPostProcessor(Set<String>) - Constructor for class io.wcm.handler.link.processor.AbstractInternalLinkInheritUrlParamLinkPostProcessor

acceptPage(Page, InternalLinkResolverOptions) - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolver

Check if a given page is valid and acceptable to link upon.

accepts(Link) - Method in class io.wcm.handler.link.markup.DummyLinkMarkupBuilder

accepts(Link) - Method in class io.wcm.handler.link.markup.SimpleLinkMarkupBuilder

accepts(Link) - Method in interface io.wcm.handler.link.spi.LinkMarkupBuilder

Checks whether this builder can generate markup for the given link.

accepts(LinkRequest) - Method in class io.wcm.handler.link.spi.LinkType

Checks whether a link reference can be handled by this link type

accepts(String) - Method in class io.wcm.handler.link.spi.LinkType

Checks whether a link reference string can be handled by this link type

accepts(String) - Method in class io.wcm.handler.link.type.ExternalLinkType

accepts(String) - Method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

accepts(LinkRequest) - Method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

accepts(String) - Method in class io.wcm.handler.link.type.InternalLinkType

accepts(LinkRequest) - Method in class io.wcm.handler.link.type.InternalLinkType

accepts(String) - Method in class io.wcm.handler.link.type.MediaLinkType

adaptTo(Class<Type>) - Method in class io.wcm.handler.link.SyntheticLinkResource

args(LinkArgs) - Method in interface io.wcm.handler.link.LinkBuilder

Set link arguments

B

build() - Method in interface io.wcm.handler.link.LinkBuilder

Resolve link and return metadata object that contains the results.

build(Link) - Method in class io.wcm.handler.link.markup.DummyLinkMarkupBuilder

build(Link) - Method in class io.wcm.handler.link.markup.SimpleLinkMarkupBuilder

build(Link) - Method in interface io.wcm.handler.link.spi.LinkMarkupBuilder

Build link anchor markup

buildAnchor() - Method in interface io.wcm.handler.link.LinkBuilder

Resolve link and return directly the markup as DOM element generated by the link markup builder.

buildMarkup() - Method in interface io.wcm.handler.link.LinkBuilder

Resolve link and return directly the markup generated by the link markup builder.

buildUrl() - Method in interface io.wcm.handler.link.LinkBuilder

Resolve link and get URL.

C

clone() - Method in class io.wcm.handler.link.LinkArgs

Custom clone-method for LinkArgs

D

decreaseCount() - Method in class io.wcm.handler.link.type.helpers.LinkResolveCounter

Decrease counter by 1.

DEFAULT_INHERIT_URL_PARAMETER_NAMES - Static variable in class io.wcm.handler.link.processor.DefaultInternalLinkInheritUrlParamLinkPostProcessor

Default list of inheritable URL parameter names

DefaultInternalLinkInheritUrlParamLinkPostProcessor - Class in io.wcm.handler.link.processor

Linkhandler postprocessor to inherit URL parametres to internal links.

DefaultInternalLinkInheritUrlParamLinkPostProcessor() - Constructor for class io.wcm.handler.link.processor.DefaultInternalLinkInheritUrlParamLinkPostProcessor

Initialize inherited URL parameter names.

dummyLink(boolean) - Method in class io.wcm.handler.link.LinkArgs

dummyLink(boolean) - Method in interface io.wcm.handler.link.LinkBuilder

DummyLinkMarkupBuilder - Class in io.wcm.handler.link.markup

Very basic implementation of LinkMarkupBuilder

DummyLinkMarkupBuilder() - Constructor for class io.wcm.handler.link.markup.DummyLinkMarkupBuilder

dummyLinkUrl(String) - Method in class io.wcm.handler.link.LinkArgs

dummyLinkUrl(String) - Method in interface io.wcm.handler.link.LinkBuilder

E

equals(Object) - Method in class io.wcm.handler.link.LinkArgs

extension(String) - Method in class io.wcm.handler.link.LinkArgs

extension(String) - Method in interface io.wcm.handler.link.LinkBuilder

Set file extension

ExternalLinkType - Class in io.wcm.handler.link.type

Default implementation of LinkType for external links.

ExternalLinkType() - Constructor for class io.wcm.handler.link.type.ExternalLinkType

F

fragment(String) - Method in class io.wcm.handler.link.LinkArgs

fragment(String) - Method in interface io.wcm.handler.link.LinkBuilder

Set fragment identifier

G

get(Resource) - Method in interface io.wcm.handler.link.LinkHandler

Build link which is referenced in the resource (containing properties e.g. pointing to internal or external link).

get(Page) - Method in interface io.wcm.handler.link.LinkHandler

Build internal link referencing the given content page.

get(LinkRequest) - Method in interface io.wcm.handler.link.LinkHandler

Build link for the given request holding all further request properties.

get() - Static method in class io.wcm.handler.link.type.helpers.LinkResolveCounter

getAnchor() - Method in class io.wcm.handler.link.Link

getAnchorAttributes() - Method in class io.wcm.handler.link.Link

getAttributes() - Method in class io.wcm.handler.link.ui.ResourceLink

Returns a map of attributes which can be applied to a HTML anchor element.

getCount() - Method in class io.wcm.handler.link.type.helpers.LinkResolveCounter

getDummyLinkUrl() - Method in class io.wcm.handler.link.LinkArgs

getExtension() - Method in class io.wcm.handler.link.LinkArgs

getFragment() - Method in class io.wcm.handler.link.LinkArgs

getId() - Method in class io.wcm.handler.link.spi.LinkType

getId() - Method in class io.wcm.handler.link.type.ExternalLinkType

getId() - Method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

getId() - Method in class io.wcm.handler.link.type.InternalLinkType

getId() - Method in class io.wcm.handler.link.type.MediaLinkType

getLinkArgs() - Method in class io.wcm.handler.link.LinkRequest

getLinkRequest() - Method in class io.wcm.handler.link.Link

getLinkType() - Method in class io.wcm.handler.link.Link

getLinkTypes() - Method in class io.wcm.handler.link.spi.LinkHandlerConfig

getMarkup() - Method in class io.wcm.handler.link.Link

getMarkupBuilders() - Method in class io.wcm.handler.link.spi.LinkHandlerConfig

getMetadata() - Method in class io.wcm.handler.link.ui.ResourceLink

Returns a Link object with the metadata of the resolved link.

getPage() - Method in class io.wcm.handler.link.LinkRequest

getPostProcessors() - Method in class io.wcm.handler.link.spi.LinkHandlerConfig

getPreProcessors() - Method in class io.wcm.handler.link.spi.LinkHandlerConfig

getPrimaryLinkRefProperty() - Method in class io.wcm.handler.link.spi.LinkType

getPrimaryLinkRefProperty() - Method in class io.wcm.handler.link.type.ExternalLinkType

getPrimaryLinkRefProperty() - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

Primary ink reference property.

getPrimaryLinkRefProperty() - Method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

getPrimaryLinkRefProperty() - Method in class io.wcm.handler.link.type.InternalLinkType

getPrimaryLinkRefProperty() - Method in class io.wcm.handler.link.type.MediaLinkType

getProperties() - Method in class io.wcm.handler.link.LinkArgs

Custom properties that my be used by application-specific markup builders or processors.

getQueryString() - Method in class io.wcm.handler.link.LinkArgs

getResource() - Method in class io.wcm.handler.link.LinkRequest

getResourceProperties() - Method in class io.wcm.handler.link.LinkRequest

getSelectors() - Method in class io.wcm.handler.link.LinkArgs

getSuffix() - Method in class io.wcm.handler.link.LinkArgs

getSyntheticLinkResource(ResourceResolver, String) - Static method in class io.wcm.handler.link.type.ExternalLinkType

Get synthetic link resource for this link type.

getSyntheticLinkResource(ResourceResolver, String) - Static method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

Get synthetic link resource for this link type.

getSyntheticLinkResource(ResourceResolver, String) - Static method in class io.wcm.handler.link.type.InternalLinkType

Get synthetic link resource for this link type.

getSyntheticLinkResource(ResourceResolver, String) - Static method in class io.wcm.handler.link.type.MediaLinkType

Get synthetic link resource for this link type.

getTargetAsset() - Method in class io.wcm.handler.link.Link

getTargetPage() - Method in class io.wcm.handler.link.Link

getTargetRendition() - Method in class io.wcm.handler.link.Link

getUrl() - Method in class io.wcm.handler.link.Link

getUrlMode() - Method in class io.wcm.handler.link.LinkArgs

H

hashCode() - Method in class io.wcm.handler.link.LinkArgs

I

ID - Static variable in class io.wcm.handler.link.type.ExternalLinkType

Link type ID

ID - Static variable in class io.wcm.handler.link.type.InternalCrossScopeLinkType

Link type ID

ID - Static variable in class io.wcm.handler.link.type.InternalLinkType

Link type ID

ID - Static variable in class io.wcm.handler.link.type.MediaLinkType

Link type ID

increaseCount() - Method in class io.wcm.handler.link.type.helpers.LinkResolveCounter

Increase counter by 1.

InternalCrossScopeLinkType - Class in io.wcm.handler.link.type

Implementation of LinkType for internal links with supports links between different configuration scopes (which normally relates to different sites/languages).

InternalCrossScopeLinkType() - Constructor for class io.wcm.handler.link.type.InternalCrossScopeLinkType

InternalLinkResolver - Class in io.wcm.handler.link.type.helpers

Implements resolving an internal link for link types.

InternalLinkResolver() - Constructor for class io.wcm.handler.link.type.helpers.InternalLinkResolver

InternalLinkResolverOptions - Class in io.wcm.handler.link.type.helpers

Options to influence the link resolving process from InternalLinkResolver.

InternalLinkResolverOptions() - Constructor for class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

InternalLinkType - Class in io.wcm.handler.link.type

Default implementation of LinkType for internal links.

InternalLinkType() - Constructor for class io.wcm.handler.link.type.InternalLinkType

INVALID_LINK - Static variable in interface io.wcm.handler.link.LinkHandler

Special link used to notify invalid links.

io.wcm.handler.link - package io.wcm.handler.link

Link Handler API.

io.wcm.handler.link.markup - package io.wcm.handler.link.markup

Default link markup builder implementations.

io.wcm.handler.link.processor - package io.wcm.handler.link.processor

Default implementations for link pre- and postprocessors.

io.wcm.handler.link.spi - package io.wcm.handler.link.spi

SPI for configuring and tailoring link handler processing.

io.wcm.handler.link.type - package io.wcm.handler.link.type

Default link type implementations.

io.wcm.handler.link.type.helpers - package io.wcm.handler.link.type.helpers

Convenience classes for implementing link types.

io.wcm.handler.link.ui - package io.wcm.handler.link.ui

Sling model classes for UI views.

isDefaultMediaContentPath(String) - Static method in class io.wcm.handler.link.type.MediaLinkType

isDummyLink() - Method in class io.wcm.handler.link.LinkArgs

isLinkReferenceInvalid() - Method in class io.wcm.handler.link.Link

isMaximumReached() - Method in class io.wcm.handler.link.type.helpers.LinkResolveCounter

isRedirect(Page) - Method in class io.wcm.handler.link.spi.LinkHandlerConfig

Detected if page contains redirect link information

isRenderPage() - Method in class io.wcm.handler.link.ui.Redirect

isRewritePathToContext() - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

Rewrite path to context.

isUseTargetContext() - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

User target context for URL building.

isValid() - Method in class io.wcm.handler.link.Link

isValid() - Method in class io.wcm.handler.link.ui.ResourceLink

Returns true if the link was resolved successful.

isValidLinkTarget(Page) - Method in class io.wcm.handler.link.spi.LinkHandlerConfig

Detected if page is acceptable as link target.

L

Link - Class in io.wcm.handler.link

Holds information about a link processed and resolved by LinkHandler.

Link(LinkType, LinkRequest) - Constructor for class io.wcm.handler.link.Link

LinkArgs - Class in io.wcm.handler.link

Holds parameters to influence the link resolving process.

LinkArgs() - Constructor for class io.wcm.handler.link.LinkArgs

LinkBuilder - Interface in io.wcm.handler.link

Define link handling request using builder pattern.

LinkHandler - Interface in io.wcm.handler.link

Manages link resolving and markup generation.

LinkHandlerConfig - Class in io.wcm.handler.link.spi

LinkHandlerConfig OSGi services provide application-specific configuration for link handling.

LinkHandlerConfig() - Constructor for class io.wcm.handler.link.spi.LinkHandlerConfig

LinkMarkupBuilder - Interface in io.wcm.handler.link.spi

Builds XHTML markup for links.

LinkNameConstants - Class in io.wcm.handler.link

Names used for link handling.

LinkProcessor - Interface in io.wcm.handler.link.spi

Processes link metadata before or after link resolving.

LinkRequest - Class in io.wcm.handler.link

Holds all properties that are part of a link handling request.

LinkRequest(Resource, Page, LinkArgs) - Constructor for class io.wcm.handler.link.LinkRequest

LinkResolveCounter - Class in io.wcm.handler.link.type.helpers

Counts number of recursive link resolve requests to detect endless loops.

LinkResolveCounter() - Constructor for class io.wcm.handler.link.type.helpers.LinkResolveCounter

LinkType - Class in io.wcm.handler.link.spi

Defines a link type supported by LinkHandler.

LinkType() - Constructor for class io.wcm.handler.link.spi.LinkType

M

MediaLinkType - Class in io.wcm.handler.link.type

Default implementation of LinkType for media links.

MediaLinkType() - Constructor for class io.wcm.handler.link.type.MediaLinkType

P

PN_LINK_CONTENT_REF - Static variable in class io.wcm.handler.link.LinkNameConstants

Internal content page path

PN_LINK_EXTERNAL_REF - Static variable in class io.wcm.handler.link.LinkNameConstants

External URL

PN_LINK_FRAGMENT - Static variable in class io.wcm.handler.link.LinkNameConstants

Name of fragment

PN_LINK_MEDIA_DOWNLOAD - Static variable in class io.wcm.handler.link.LinkNameConstants

Open media library item with download dialog

PN_LINK_MEDIA_REF - Static variable in class io.wcm.handler.link.LinkNameConstants

Internal media library item path

PN_LINK_QUERY_PARAM - Static variable in class io.wcm.handler.link.LinkNameConstants

Open media library item with download dialog

PN_LINK_TITLE - Static variable in class io.wcm.handler.link.LinkNameConstants

Link title

PN_LINK_TYPE - Static variable in class io.wcm.handler.link.LinkNameConstants

Link type

PN_LINK_WINDOW_FEATURES - Static variable in class io.wcm.handler.link.LinkNameConstants

Window features

PN_LINK_WINDOW_HEIGHT - Static variable in class io.wcm.handler.link.LinkNameConstants

Window height (px)

PN_LINK_WINDOW_TARGET - Static variable in class io.wcm.handler.link.LinkNameConstants

Window target name

PN_LINK_WINDOW_WIDTH - Static variable in class io.wcm.handler.link.LinkNameConstants

Window width (px)

primaryLinkRefProperty(String) - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

Primary ink reference property.

process(Link) - Method in class io.wcm.handler.link.processor.AbstractInternalLinkInheritUrlParamLinkPostProcessor

process(Link) - Method in interface io.wcm.handler.link.spi.LinkProcessor

Process link metadata

properties(Map<String, Object>) - Method in class io.wcm.handler.link.LinkArgs

Custom properties that my be used by application-specific markup builders or processors.

property(String, Object) - Method in class io.wcm.handler.link.LinkArgs

Custom properties that my be used by application-specific markup builders or processors.

Q

queryString(String) - Method in class io.wcm.handler.link.LinkArgs

queryString(String) - Method in interface io.wcm.handler.link.LinkBuilder

Set query parameters string

R

Redirect - Class in io.wcm.handler.link.ui

Sets HTTP status and 'location' header for server-side redirect.

Redirect() - Constructor for class io.wcm.handler.link.ui.Redirect

resolveLink(Link) - Method in class io.wcm.handler.link.spi.LinkType

Resolves a link

resolveLink(Link) - Method in class io.wcm.handler.link.type.ExternalLinkType

resolveLink(Link, InternalLinkResolverOptions) - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolver

Resolves a link and stores the result in the link object.

resolveLink(Link) - Method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

resolveLink(Link) - Method in class io.wcm.handler.link.type.InternalLinkType

resolveLink(Link) - Method in class io.wcm.handler.link.type.MediaLinkType

ResourceLink - Class in io.wcm.handler.link.ui

Generic resource-based link model.

ResourceLink() - Constructor for class io.wcm.handler.link.ui.ResourceLink

rewritePathToContext(boolean) - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

Rewrite path to context.

S

selectors(String) - Method in class io.wcm.handler.link.LinkArgs

selectors(String) - Method in interface io.wcm.handler.link.LinkBuilder

Set selectors

setAnchor(Anchor) - Method in class io.wcm.handler.link.Link

setLinkReferenceInvalid(boolean) - Method in class io.wcm.handler.link.Link

setLinkRequest(LinkRequest) - Method in class io.wcm.handler.link.Link

setTargetAsset(Asset) - Method in class io.wcm.handler.link.Link

setTargetPage(Page) - Method in class io.wcm.handler.link.Link

setTargetRendition(Rendition) - Method in class io.wcm.handler.link.Link

setUrl(String) - Method in class io.wcm.handler.link.Link

SimpleLinkMarkupBuilder - Class in io.wcm.handler.link.markup

Very basic implementation of LinkMarkupBuilder

SimpleLinkMarkupBuilder() - Constructor for class io.wcm.handler.link.markup.SimpleLinkMarkupBuilder

suffix(String) - Method in class io.wcm.handler.link.LinkArgs

suffix(String) - Method in interface io.wcm.handler.link.LinkBuilder

Set suffix

SyntheticLinkResource - Class in io.wcm.handler.link

Synthetic resource for building links via LinkHandler.

SyntheticLinkResource(ResourceResolver) - Constructor for class io.wcm.handler.link.SyntheticLinkResource

Instantiate resource with static path/resource type

SyntheticLinkResource(ResourceResolver, Map<String, Object>) - Constructor for class io.wcm.handler.link.SyntheticLinkResource

Instantiate resource with static path/resource type

T

toString() - Method in class io.wcm.handler.link.Link

toString() - Method in class io.wcm.handler.link.LinkArgs

toString() - Method in class io.wcm.handler.link.LinkRequest

toString() - Method in class io.wcm.handler.link.type.ExternalLinkType

toString() - Method in class io.wcm.handler.link.type.InternalCrossScopeLinkType

toString() - Method in class io.wcm.handler.link.type.InternalLinkType

toString() - Method in class io.wcm.handler.link.type.MediaLinkType

U

urlMode(UrlMode) - Method in class io.wcm.handler.link.LinkArgs

urlMode(UrlMode) - Method in interface io.wcm.handler.link.LinkBuilder

Set URL mode for externalizing the URL

useTargetContext(boolean) - Method in class io.wcm.handler.link.type.helpers.InternalLinkResolverOptions

User target context for URL building.

A B C D E F G H I L M P Q R S T U