com.ibm.workplace.wcm.api
Interface ShortTextComponent

All Superinterfaces:

ContentComponent, TextComponent, WCMApiObject

public interface ShortTextComponent
extends TextComponent

Represents a Short Text component.

A ShortTextComponent is a ContentComponent and cannot be stored as a separate entity in the repository.

A ShortTextComponent contains plain text of limited length. This interface provides methods to retrieve and set the text contained within this component.

note: since v6.0.0, a ShortTextComponent is referred to as an "Short Text Element" in the Authoring UI.

See Also:

ContentComponent, TextComponent

Method Summary

DocumentType<? extends ShortTextComponent>

getDocumentType() Returns the DocumentType of the ContentComponent.

Methods inherited from interface com.ibm.workplace.wcm.api.TextComponent

getText, setText

Methods inherited from interface com.ibm.workplace.wcm.api.ContentComponent

getContainer, getName, getTitleTextProviderKey, getTitleTextProviderName, setTitleTextProviderKey, setTitleTextProviderName

Method Detail

getDocumentType

DocumentType<? extends ShortTextComponent> getDocumentType()

Description copied from interface: ContentComponent

Returns the DocumentType of the ContentComponent.

Specified by:

getDocumentType in interface ContentComponent

Specified by:

getDocumentType in interface TextComponent

Returns:

the type

See Also:

ContentComponent.getDocumentType()