java.lang.Object

cruise.umple.docs.Content

public class Content
extends java.lang.Object

Data for the user manual taken from one of the files in build/reference

Constructor Summary

Constructors

Constructor Description

Content(java.lang.String aTitle, java.lang.String aDescription, java.lang.String aSyntax, java.lang.String aFilename)

Method Summary

Modifier and Type	Method	Description
`boolean`	`addExample(ManualExample aExample)`
`boolean`	`addExampleAt(ManualExample aExample, int index)`
`boolean`	`addOrMoveExampleAt(ManualExample aExample, int index)`
`void`	`delete()`
`java.lang.String`	`getDescription()`	Html for the core of the manual page
`ManualExample`	`getExample(int index)`
`java.util.List<ManualExample>`	`getExamples()`	Short samples of Umple code
`java.lang.String`	`getFilename()`	Original source filename
`boolean`	`getShouldIncludeReferences()`	Legacy - to be deleted - used to represent whether cross-references should Be created
`java.lang.String`	`getSyntax()`	Grammar rules associated with this user manual page
`java.lang.String`	`getTitle()`	Title of the user manual page
`java.lang.String`	`getTitleFilename()`
`java.lang.String`	`getTooltip()`	Tooltip to display when hovering (if any)
`java.lang.String`	`getVideoURL()`	URL of Youtube Video (if any)
`boolean`	`hasExamples()`
`int`	`indexOfExample(ManualExample aExample)`
`boolean`	`isShouldIncludeReferences()`
`static int`	`minimumNumberOfExamples()`
`int`	`numberOfExamples()`
`boolean`	`removeExample(ManualExample aExample)`
`boolean`	`setDescription(java.lang.String aDescription)`
`boolean`	`setFilename(java.lang.String aFilename)`
`boolean`	`setShouldIncludeReferences(boolean aShouldIncludeReferences)`
`boolean`	`setSyntax(java.lang.String aSyntax)`
`boolean`	`setTitle(java.lang.String aTitle)`
`boolean`	`setTooltip(java.lang.String aTooltip)`
`boolean`	`setVideoURL(java.lang.String aVideoURL)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Constructor Details
- Content
  
  public Content(java.lang.String aTitle, java.lang.String aDescription, java.lang.String aSyntax, java.lang.String aFilename)
Method Details
- setTitle
  
  public boolean setTitle(java.lang.String aTitle)
- setShouldIncludeReferences
  
  public boolean setShouldIncludeReferences(boolean aShouldIncludeReferences)
- setDescription
  
  public boolean setDescription(java.lang.String aDescription)
- setSyntax
  
  public boolean setSyntax(java.lang.String aSyntax)
- setFilename
  
  public boolean setFilename(java.lang.String aFilename)
- setVideoURL
  
  public boolean setVideoURL(java.lang.String aVideoURL)
- setTooltip
  
  public boolean setTooltip(java.lang.String aTooltip)
- getTitle
  
  public java.lang.String getTitle()
  
  Title of the user manual page
- getShouldIncludeReferences
  
  public boolean getShouldIncludeReferences()
  
  Legacy - to be deleted - used to represent whether cross-references should Be created
- getDescription
  
  public java.lang.String getDescription()
  
  Html for the core of the manual page
- getSyntax
  
  public java.lang.String getSyntax()
  
  Grammar rules associated with this user manual page
- getFilename
  
  public java.lang.String getFilename()
  
  Original source filename
- getVideoURL
  
  public java.lang.String getVideoURL()
  
  URL of Youtube Video (if any)
- getTooltip
  
  public java.lang.String getTooltip()
  
  Tooltip to display when hovering (if any)
- isShouldIncludeReferences
  
  public boolean isShouldIncludeReferences()
- getExample
  
  public ManualExample getExample(int index)
- getExamples
  
  public java.util.List<ManualExample> getExamples()
  
  Short samples of Umple code
- numberOfExamples
  
  public int numberOfExamples()
- hasExamples
  
  public boolean hasExamples()
- indexOfExample
  
  public int indexOfExample(ManualExample aExample)
- minimumNumberOfExamples
  
  public static int minimumNumberOfExamples()
- addExample
  
  public boolean addExample(ManualExample aExample)
- removeExample
  
  public boolean removeExample(ManualExample aExample)
- addExampleAt
  
  public boolean addExampleAt(ManualExample aExample, int index)
- addOrMoveExampleAt
  
  public boolean addOrMoveExampleAt(ManualExample aExample, int index)
- delete
  
  public void delete()
- getTitleFilename
  
  public java.lang.String getTitleFilename()
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class Content

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

Method Details