ShortcutCaption (Web API 2021)

java.lang.Object
- com.microstrategy.web.app.gui.AbstractGuiElement
- - com.microstrategy.web.app.gui.shortcuts.AbstractShortcut
  - - com.microstrategy.web.app.gui.shortcuts.ShortcutCaption

All Implemented Interfaces:

GuiElement, ShortcutElement
```
public class ShortcutCaption
extends AbstractShortcut
```
Title: ShortcutCaption.
This class renders a button shortcut that includes some text. Depending how it was configured, it might render this:
```
 <div id="id" class="caption">
   <img src=.../>
 </div>
 
```
or:
```
 <div id="id" class="caption">
   <span>Text</span>
 </div>
 
```
If required, it might be enclosed by an anchor tag.
Since:

MicroStrategy Web 8.0.0

Field Summary
- Fields inherited from class com.microstrategy.web.app.gui.AbstractGuiElement
  _appContext, _name, _webComponent

Constructor Summary

Constructors
Constructor Description

ShortcutCaption()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`renderElement(MarkupOutput out)`	Render the instance according to the information provided on its configuration.

Methods inherited from class com.microstrategy.web.app.gui.shortcuts.AbstractShortcut
addAttributesToTag, get1ptrans, getFeaturesRoot, getImgTag, getLinkTag, getShortcut, isIncludeSubItems, renderElement, setIncludeSubItems, setShortcut

Methods inherited from class com.microstrategy.web.app.gui.AbstractGuiElement
getAppContext, getDescriptor, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getTagsFactory, getUseIFrame, getWebComponent, isDhtml, isIFrameEnabled, newHiddenInputBuilder, newNamespaceEncoder, newURIBuilder, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.microstrategy.web.app.gui.GuiElement
getAppContext, getDescriptor, getDescriptor, getEventManager, getExtraInput, getExtraUrl, getFeatures, getMessages, getName, getUseIFrame, getWebComponent, setAppContext, setExtraInput, setExtraUrl, setName, setUseIFrame, setWebComponent

- Constructor Detail
  - ShortcutCaption
```
public ShortcutCaption()
```
- Method Detail
  - renderElement
```
public boolean renderElement(MarkupOutput out)
```
    Render the instance according to the information provided on its configuration.
    
    Specified by:
    
    renderElement in interface GuiElement
    
    Overrides:
    
    renderElement in class AbstractGuiElement
    
    Parameters:
    
    out - MarkupOutput instance where the HTML information to display to the user is to be saved.
    
    Returns:
    
    MarkupOutput instance initialized with the HTML information to display to the user.