Package edu.cnu.mdi.splot.plot

Class PlotViewInfo

java.lang.Object

edu.cnu.mdi.view.AbstractViewInfo

edu.cnu.mdi.splot.plot.PlotViewInfo

public class PlotViewInfo
extends AbstractViewInfo

View info for the plot view. This provides metadata about the view, including its title, purpose, and usage instructions.

Constructor Summary

Constructors

Constructor	Description
PlotViewInfo()

Method Summary

Modifier and Type	Method	Description
String	getPurpose()
String	getTitle()
List<String>	getUsageBullets()	Usage bullets (preferred).
protected boolean	isPurposeHtml()	If you really need custom HTML for purpose, override this and return true.

Methods inherited from class edu.cnu.mdi.view.AbstractViewInfo

getAccentColorHex, getAsHTML, getFooter, getKeyboardShortcuts, getTechnicalNotes, getTextColorHex, getTitleColorHex, getUsageHtml, getUsageSteps

Methods inherited from class java.lang.Object

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

Constructor Details

PlotViewInfo

public PlotViewInfo()

Method Details

getTitle

public String getTitle()

Specified by:

getTitle in class AbstractViewInfo

Returns:

The title shown at top of the Info dialog.

getPurpose

public String getPurpose()

Specified by:

getPurpose in class AbstractViewInfo

Returns:

Short description of what this view is for. Plain text by default.

getUsageBullets

public List<String> getUsageBullets()

Description copied from class: AbstractViewInfo

Usage bullets (preferred). Each bullet should be plain text (not HTML). The framework will escape it.

Overrides:

getUsageBullets in class AbstractViewInfo

Returns:

List of usage bullets, or empty list if none.

isPurposeHtml

protected boolean isPurposeHtml()

Description copied from class: AbstractViewInfo

If you really need custom HTML for purpose, override this and return true. Default: purpose is escaped as plain text.

Overrides:

isPurposeHtml in class AbstractViewInfo