com.adobe.cq.editor.model.inplaceediting.config

Class Plugin

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

org.apache.sling.api.resource.AbstractResource

com.adobe.cq.editor.model.inplaceediting.config.Plugin

All Implemented Interfaces:

Adaptable, Resource

Direct Known Subclasses:

PluginFeature

@Model(adaptables=SlingHttpServletRequest.class)
public class Plugin
extends AbstractResource

Representation suitable for configuring a plugin resource in the context of the In Place Editors

Field Summary

Fields inherited from interface org.apache.sling.api.resource.Resource

RESOURCE_TYPE_NON_EXISTING

Constructor Summary

Constructors

Constructor and Description
Plugin()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassNames() List of default and provided class names
java.lang.String	getFeatures() List of features provided by the current Plugin
java.lang.String	getName() Name of the plugin
java.lang.String	getPath() Returns the absolute path of this resource in the resource tree.
java.lang.String	getPluginName() Name of the plugin
ResourceMetadata	getResourceMetadata() Returns the meta data of this resource.
ResourceResolver	getResourceResolver() Returns the ResourceResolver from which this resource has been retrieved.
java.lang.String	getResourceSuperType() Returns the super type of the resource if the resource defines its own super type.
java.lang.String	getResourceType() The resource type is meant to point to rendering/processing scripts, editing dialogs, etc.
java.lang.String	getTitle() Title of the plugin
java.lang.Boolean	isEnabled() Should the plugin be enabled

Methods inherited from class org.apache.sling.api.resource.AbstractResource

getChild, getChildren, getParent, getValueMap, hasChildren, isResourceType, listChildren

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

adaptTo, setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Constructor Detail

Plugin

public Plugin()

Method Detail

getTitle

public java.lang.String getTitle()

Title of the plugin

Returns:

Title of the plugin

getPluginName

public java.lang.String getPluginName()

Name of the plugin

Returns:

getName

public java.lang.String getName()

Name of the plugin

Specified by:

getName in interface Resource

Overrides:

getName in class AbstractResource

Returns:

Name of the plugin

getPath

public java.lang.String getPath()

Description copied from interface: Resource

Returns the absolute path of this resource in the resource tree.

Returns:

The resource path

getResourceType

public java.lang.String getResourceType()

Description copied from interface: Resource

The resource type is meant to point to rendering/processing scripts, editing dialogs, etc. It is usually a path in the repository, where scripts and other tools definitions are found, but the ResourceResolver is free to set this to any suitable value such as the primary node type of the JCR node from which the resource is created.

If the resource instance represents a resource which is not actually existing, this method returns Resource.RESOURCE_TYPE_NON_EXISTING.

Returns:

The resource type

getResourceSuperType

public java.lang.String getResourceSuperType()

Description copied from interface: Resource

Returns the super type of the resource if the resource defines its own super type. Otherwise null is returned. A resource might return a resource super type to overwrite the resource type hierarchy. If a client is interested in the effective resource super type of a resource, it should call ResourceResolver.getParentResourceType(Resource).

Returns:

The super type of the resource or null.

getResourceMetadata

public ResourceMetadata getResourceMetadata()

Description copied from interface: Resource

Returns the meta data of this resource. The concrete data contained in the ResourceMetadata object returned is implementation specific except for the ResourceMetadata.RESOLUTION_PATH property which is required to be set to the part of the request URI used to resolve the resource.

Returns:

The resource meta data

See Also:

ResourceMetadata

getResourceResolver

public ResourceResolver getResourceResolver()

Description copied from interface: Resource

Returns the ResourceResolver from which this resource has been retrieved.

Returns:

The resource resolver

getFeatures

public java.lang.String getFeatures()

List of features provided by the current Plugin

Returns:

The features value

isEnabled

public java.lang.Boolean isEnabled()

Should the plugin be enabled

Returns:

Status of the plugin

getClassNames

public java.lang.String getClassNames()

List of default and provided class names

Returns:

Concatenated class names