com.adobe.aemds.guide.common

Class GuideImage

java.lang.Object

com.adobe.cq.sightly.WCMUsePojo

com.adobe.aemds.guide.common.GuideNode

com.adobe.aemds.guide.common.GuideField

com.adobe.aemds.guide.common.GuideImage

All Implemented Interfaces:

FDField, StyledFDField, java.io.Serializable, Use

public class GuideImage
extends GuideField
implements java.io.Serializable

GuideImage class encapsulates basic properties of the adaptive forms Image Component. The properties that it encapsulates are listed below:

• Source of the image
• Alternate Text of the image
• Height of the image

Since:

AEM 6.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GuideImage()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAltText() Returns the alternate text of the Image configured in the authoring dialog.
java.lang.String	getDropTargetClass() Returns the drop target class.
java.lang.String	getGuideFieldType() Returns the field type of the Adaptive Forms Component
java.lang.String	getHeight() Returns the height of image configured in the authoring dialog
java.lang.String	getImageSrc() Returns the source where the image is present.
java.lang.String	getStyles() Returns the string containing the width and height property represented as an inline CSS rule.

Methods inherited from class com.adobe.aemds.guide.common.GuideField

getAuthoringConfig, getAutocomplete, getAutofillFieldKeyword, getCaptionInlineStyles, getDescriptionVisibility, getErrorSimulatorString, getFieldLayout, getFieldLayoutName, getHelpIndicatorContent, getHideTitle, getIsOldFieldLayout, getIsReadOnly, getIsRequired, getLabelForId, getLongDescription, getPlaceholderText, getShortDescription, getShortDescriptionInlineStyles, getValue, getWidgetInlineStyles, isMandatory, setHelpIndicatorContent

Methods inherited from class com.adobe.aemds.guide.common.GuideNode

activate, checkIfPathIsAbsolute, externalize, getAddMessage, getAppearance, getAuthoringConfigJSON, getBindRef, getClientLibRef, getColspan, getCssClassName, getDescription, getEnabledExp, getError, getFieldInlineStyles, getId, getInlineCssClass, getInlineStyles, getIsEditMode, getIsRepeatable, getItems, getLayoutPath, getLayoutTabType, getLongDescriptionInlineStyles, getName, getNavTitle, getNodeClass, getNonNavigableProperty, getPath, getQuestionMarkInlineStyles, getRemoveMessage, getResourceSuperType, getResourceType, getResponsiveClasses, getResponsiveConfiguration, getSlingRequest, getTargetVersion, getTitle, getToolbarPosition, getVersion, getVisibleExp, getWidth, getXssapi, getXssDescription, isDocumentFragmentGroup, isLayoutNavigable, isMenuRequired, isValid, isValidDorTemplateRef, setClientLibRef, setResource, setSlingRequest, syncNode

Methods inherited from class com.adobe.cq.sightly.WCMUsePojo

get, getComponent, getComponentContext, getCurrentDesign, getCurrentPage, getCurrentStyle, getDesigner, getEditContext, getInheritedPageProperties, getInheritedProperties, getPageManager, getPageProperties, getProperties, getRequest, getResource, getResourceDesign, getResourcePage, getResourceResolver, getResponse, getSlingScriptHelper, getWcmMode, getXSSAPI, init

Methods inherited from class java.lang.Object

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

Constructor Detail

GuideImage

public GuideImage()

Method Detail

getImageSrc

public java.lang.String getImageSrc()
                             throws javax.jcr.RepositoryException,
                                    java.io.IOException

Returns the source where the image is present.

Returns:

String representing source of the image.

Throws:

javax.jcr.RepositoryException

java.io.IOException

getStyles

public java.lang.String getStyles()

Description copied from class: GuideNode

Returns the string containing the width and height property represented as an inline CSS rule.

Overrides:

getStyles in class GuideNode

Returns:

string containing width and height as inline CSS styl

getDropTargetClass

public java.lang.String getDropTargetClass()
                                    throws javax.jcr.RepositoryException

Returns the drop target class.

Returns:

String representing drop target class for touch ui.

Throws:

javax.jcr.RepositoryException

getAltText

public java.lang.String getAltText()

Returns the alternate text of the Image configured in the authoring dialog.

Returns:

String representing alternate text

getHeight

public java.lang.String getHeight()

Returns the height of image configured in the authoring dialog

Specified by:

getHeight in interface StyledFDField

Overrides:

getHeight in class GuideNode

Returns:

String representing height of the image

getGuideFieldType

public java.lang.String getGuideFieldType()

Returns the field type of the Adaptive Forms Component

Specified by:

getGuideFieldType in interface FDField

Overrides:

getGuideFieldType in class GuideNode

Returns:

String representing guide field type