ElementRule (ANTLRWorks 1.5.2 API)

java.lang.Object
- org.antlr.works.grammar.element.ElementScopable
- - org.antlr.works.grammar.element.ElementRule

All Implemented Interfaces:: Comparable, ATEFoldingEntity, ATEGutterItem, ATEScope, EditorPersistentObject

public class ElementRule
extends ElementScopable
implements Comparable, EditorPersistentObject, ATEFoldingEntity, ATEGutterItem

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`actionsEndIndex`
`protected int`	`actionsStartIndex`
`protected int`	`blocksEndIndex`
`protected int`	`blocksStartIndex`
`boolean`	`breakpoint`
`ATEToken`	`colon`
`ATEToken`	`end`
`List<GrammarError>`	`errors`
`boolean`	`expanded`
`boolean`	`hasLeftRecursion`
`boolean`	`hierarchyAnalyzed`
`boolean`	`ignored`
`boolean`	`isOverridden`
`static int`	`ITEM_TYPE_OVERRIDDEN`
`static int`	`ITEM_TYPE_OVERRIDE`
`boolean`	`leftRecursionAnalyzed`
`Set`	`leftRecursiveRulesSet`
`boolean`	`lexer`
`String`	`name`
`boolean`	`needsToBuildErrors`
`List<String>`	`overriddenGrammars`
`boolean`	`override`
`List<String>`	`overrideGrammars`
`protected GrammarSyntaxParser`	`parser`
`protected int`	`refsEndIndex`
`protected int`	`refsStartIndex`
`ATEToken`	`start`
`List<Integer>`	`types`

Fields inherited from class org.antlr.works.grammar.element.ElementScopable
scope

Constructor Summary

Constructors
Constructor and Description
`ElementRule(GrammarSyntaxParser parser, String name, ATEToken start, ATEToken colon, ATEToken end)`
`ElementRule(String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canBeCollapsed()`
`int`	`compareTo(Object o)`
`void`	`completed()`
`boolean`	`containsIndex(int index)`
`boolean`	`detectLeftRecursion()`
`boolean`	`foldingEntityCanBeCollapsed()`
`int`	`foldingEntityGetEndIndex()`
`int`	`foldingEntityGetEndLine()`
`int`	`foldingEntityGetStartIndex()`
`int`	`foldingEntityGetStartLine()`
`int`	`foldingEntityGetStartParagraphIndex()`
`String`	`foldingEntityID()`
`boolean`	`foldingEntityIsExpanded()`
`int`	`foldingEntityLevel()`
`String`	`foldingEntityPlaceholderString()`
`void`	`foldingEntitySetExpanded(boolean expanded)`
`List<ElementAction>`	`getActions()`
`List<List<ATEToken>>`	`getAlternatives()`
`List<ElementBlock>`	`getBlocks()`
`int`	`getEndIndex()`
`GrammarEngine`	`getEngine()`
`String`	`getErrorMessageHTML()`
`String`	`getErrorMessageString(int index)`
`List<GrammarError>`	`getErrors()`
`int`	`getInternalTokensEndIndex()`
`int`	`getInternalTokensStartIndex()`
`int`	`getItemHeight()`
`ImageIcon`	`getItemIcon(int type)`
`int`	`getItemIndex()`
`String`	`getItemTooltip(int type)`
`List<Integer>`	`getItemTypes()`
`int`	`getItemWidth()`
`Set`	`getLeftRecursiveRulesSet()`
`int`	`getLength()`
`Object`	`getPersistentID()`
`List<ElementReference>`	`getReferences()`
`int`	`getStartIndex()`
`String`	`getTextRuleAfterRemovingLeftRecursion()`
`List<ATEToken>`	`getTokens()`
`int`	`getUniqueIdentifier()`
`boolean`	`hasErrors()`
`boolean`	`hasLeftRecursion()`
`boolean`	`isExpanded()`
`void`	`itemAction(int type)`
`boolean`	`needsToBuildErrors()`
`void`	`persistentAssign(EditorPersistentObject otherObject)`
`void`	`resetHierarchy()`
`void`	`setActionsIndexes(int startIndex, int endIndex)`
`void`	`setBlocksIndexes(int startIndex, int endIndex)`
`void`	`setEngine(GrammarEngine engine)`
`void`	`setErrors(List<GrammarError> errors)`
`void`	`setExpanded(boolean expanded)`
`void`	`setItemIndex(int index)`
`void`	`setLeftRecursiveRulesSet(Set rulesSet)`
`void`	`setNeedsToBuildErrors(boolean flag)`
`void`	`setReferencesIndexes(int startIndex, int endIndex)`
`String`	`toString()`

Methods inherited from class org.antlr.works.grammar.element.ElementScopable
getScope, setScope

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

Field Detail

name
```
public String name
```

start
```
public ATEToken start
```

colon
```
public ATEToken colon
```

end
```
public ATEToken end
```

ignored
```
public boolean ignored
```

expanded
```
public boolean expanded
```

breakpoint
```
public boolean breakpoint
```

lexer
```
public boolean lexer
```

hasLeftRecursion
```
public boolean hasLeftRecursion
```

leftRecursionAnalyzed
```
public boolean leftRecursionAnalyzed
```

leftRecursiveRulesSet
```
public Set leftRecursiveRulesSet
```

hierarchyAnalyzed
```
public boolean hierarchyAnalyzed
```

errors
```
public List<GrammarError> errors
```

needsToBuildErrors
```
public boolean needsToBuildErrors
```

parser
```
protected GrammarSyntaxParser parser
```

refsStartIndex
```
protected int refsStartIndex
```

refsEndIndex
```
protected int refsEndIndex
```

blocksStartIndex
```
protected int blocksStartIndex
```

blocksEndIndex
```
protected int blocksEndIndex
```

actionsStartIndex
```
protected int actionsStartIndex
```

actionsEndIndex
```
protected int actionsEndIndex
```

ITEM_TYPE_OVERRIDE
```
public static final int ITEM_TYPE_OVERRIDE
```
See Also:
Constant Field Values

ITEM_TYPE_OVERRIDDEN
```
public static final int ITEM_TYPE_OVERRIDDEN
```
See Also:
Constant Field Values

override
```
public boolean override
```

overrideGrammars
```
public List<String> overrideGrammars
```

isOverridden
```
public boolean isOverridden
```

overriddenGrammars
```
public List<String> overriddenGrammars
```

types
```
public List<Integer> types
```

Constructor Detail

ElementRule
```
public ElementRule(String name)
```

ElementRule

public ElementRule(GrammarSyntaxParser parser,
           String name,
           ATEToken start,
           ATEToken colon,
           ATEToken end)

Method Detail

completed
```
public void completed()
```

resetHierarchy
```
public void resetHierarchy()
```

getEngine
```
public GrammarEngine getEngine()
```

setEngine

public void setEngine(GrammarEngine engine)

setReferencesIndexes

public void setReferencesIndexes(int startIndex,
                        int endIndex)

getReferences

public List<ElementReference> getReferences()

setBlocksIndexes

public void setBlocksIndexes(int startIndex,
                    int endIndex)

getBlocks
```
public List<ElementBlock> getBlocks()
```

setActionsIndexes

public void setActionsIndexes(int startIndex,
                     int endIndex)

getActions

public List<ElementAction> getActions()

getStartIndex
```
public int getStartIndex()
```

getEndIndex
```
public int getEndIndex()
```

getLength
```
public int getLength()
```

getInternalTokensStartIndex

public int getInternalTokensStartIndex()

getInternalTokensEndIndex

public int getInternalTokensEndIndex()

getTokens
```
public List<ATEToken> getTokens()
```

getAlternatives

public List<List<ATEToken>> getAlternatives()

setErrors

public void setErrors(List<GrammarError> errors)

getErrors
```
public List<GrammarError> getErrors()
```

setExpanded

public void setExpanded(boolean expanded)

isExpanded
```
public boolean isExpanded()
```

setLeftRecursiveRulesSet

public void setLeftRecursiveRulesSet(Set rulesSet)

getLeftRecursiveRulesSet
```
public Set getLeftRecursiveRulesSet()
```

hasLeftRecursion
```
public boolean hasLeftRecursion()
```

detectLeftRecursion
```
public boolean detectLeftRecursion()
```

getTextRuleAfterRemovingLeftRecursion

public String getTextRuleAfterRemovingLeftRecursion()

hasErrors
```
public boolean hasErrors()
```

setNeedsToBuildErrors

public void setNeedsToBuildErrors(boolean flag)

needsToBuildErrors
```
public boolean needsToBuildErrors()
```

getErrorMessageString

public String getErrorMessageString(int index)

getErrorMessageHTML
```
public String getErrorMessageHTML()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

containsIndex

public boolean containsIndex(int index)

compareTo
```
public int compareTo(Object o)
```
Specified by:

compareTo in interface Comparable

getUniqueIdentifier
```
public int getUniqueIdentifier()
```

canBeCollapsed
```
public boolean canBeCollapsed()
```

foldingEntitySetExpanded
```
public void foldingEntitySetExpanded(boolean expanded)
```
Specified by:

foldingEntitySetExpanded in interface ATEFoldingEntity

foldingEntityIsExpanded
```
public boolean foldingEntityIsExpanded()
```
Specified by:

foldingEntityIsExpanded in interface ATEFoldingEntity

foldingEntityCanBeCollapsed
```
public boolean foldingEntityCanBeCollapsed()
```
Specified by:

foldingEntityCanBeCollapsed in interface ATEFoldingEntity

foldingEntityGetStartParagraphIndex
```
public int foldingEntityGetStartParagraphIndex()
```
Specified by:

foldingEntityGetStartParagraphIndex in interface ATEFoldingEntity

foldingEntityGetStartIndex
```
public int foldingEntityGetStartIndex()
```
Specified by:

foldingEntityGetStartIndex in interface ATEFoldingEntity

foldingEntityGetEndIndex
```
public int foldingEntityGetEndIndex()
```
Specified by:

foldingEntityGetEndIndex in interface ATEFoldingEntity

foldingEntityGetStartLine
```
public int foldingEntityGetStartLine()
```
Specified by:

foldingEntityGetStartLine in interface ATEFoldingEntity

foldingEntityGetEndLine
```
public int foldingEntityGetEndLine()
```
Specified by:

foldingEntityGetEndLine in interface ATEFoldingEntity

foldingEntityPlaceholderString
```
public String foldingEntityPlaceholderString()
```
Specified by:

foldingEntityPlaceholderString in interface ATEFoldingEntity

foldingEntityID
```
public String foldingEntityID()
```
Specified by:

foldingEntityID in interface ATEFoldingEntity

foldingEntityLevel
```
public int foldingEntityLevel()
```
Specified by:

foldingEntityLevel in interface ATEFoldingEntity

getItemIndex
```
public int getItemIndex()
```
Specified by:

getItemIndex in interface ATEGutterItem

setItemIndex
```
public void setItemIndex(int index)
```
Specified by:

setItemIndex in interface ATEGutterItem

getItemTypes
```
public List<Integer> getItemTypes()
```
Specified by:

getItemTypes in interface ATEGutterItem

getItemWidth
```
public int getItemWidth()
```
Specified by:

getItemWidth in interface ATEGutterItem

getItemHeight
```
public int getItemHeight()
```
Specified by:

getItemHeight in interface ATEGutterItem

getItemIcon
```
public ImageIcon getItemIcon(int type)
```
Specified by:

getItemIcon in interface ATEGutterItem

getItemTooltip
```
public String getItemTooltip(int type)
```
Specified by:

getItemTooltip in interface ATEGutterItem

itemAction
```
public void itemAction(int type)
```
Specified by:

itemAction in interface ATEGutterItem

getPersistentID
```
public Object getPersistentID()
```
Specified by:

getPersistentID in interface EditorPersistentObject

persistentAssign
```
public void persistentAssign(EditorPersistentObject otherObject)
```
Specified by:

persistentAssign in interface EditorPersistentObject

Class ElementRule

Field Summary

Fields inherited from class org.antlr.works.grammar.element.ElementScopable

Constructor Summary

Method Summary

Methods inherited from class org.antlr.works.grammar.element.ElementScopable

Methods inherited from class java.lang.Object

Field Detail

name

start

colon

end

ignored

expanded

breakpoint

lexer

hasLeftRecursion

leftRecursionAnalyzed

leftRecursiveRulesSet

hierarchyAnalyzed

errors

needsToBuildErrors

parser

refsStartIndex

refsEndIndex

blocksStartIndex

blocksEndIndex

actionsStartIndex

actionsEndIndex

ITEM_TYPE_OVERRIDE

ITEM_TYPE_OVERRIDDEN

override

overrideGrammars

isOverridden

overriddenGrammars

types

Constructor Detail

ElementRule

ElementRule

Method Detail

completed

resetHierarchy

getEngine

setEngine

setReferencesIndexes

getReferences

setBlocksIndexes

getBlocks

setActionsIndexes

getActions

getStartIndex

getEndIndex

getLength

getInternalTokensStartIndex

getInternalTokensEndIndex

getTokens

getAlternatives

setErrors

getErrors

setExpanded

isExpanded

setLeftRecursiveRulesSet

getLeftRecursiveRulesSet

hasLeftRecursion

detectLeftRecursion

getTextRuleAfterRemovingLeftRecursion

hasErrors

setNeedsToBuildErrors

needsToBuildErrors

getErrorMessageString

getErrorMessageHTML

toString

containsIndex

compareTo

getUniqueIdentifier

canBeCollapsed

foldingEntitySetExpanded

foldingEntityIsExpanded

foldingEntityCanBeCollapsed

foldingEntityGetStartParagraphIndex