metricsOverlay.model.augmentation
Class MarginAugmentation

java.lang.Object
  extended by metricsOverlay.model.augmentation.Augmentation
      extended by metricsOverlay.model.augmentation.MarginAugmentation
All Implemented Interfaces:
java.lang.Comparable<Augmentation>, IEditable, INameable, ITyped

public class MarginAugmentation
extends Augmentation


Constructor Summary
MarginAugmentation()
           
MarginAugmentation(java.lang.String augName)
           
 
Method Summary
 void disable()
           
 int getMarginPosition()
           
 java.util.Set<int[]> getShape(int lineHeight)
           
 ShapeDirection getShapeDirection()
           
 ShapeType getShapeType()
           
 java.lang.String getType()
           
 boolean isLeft()
           
 void setIsLeft(boolean left)
           
 void setShape(ShapeType sType, ShapeDirection sDir)
           
 int totChipsOnSide()
           
 void update(MetricFile mf, Mapping mm)
          This method updates the display strategy, given an update in the eclipse java editor.
 
Methods inherited from class metricsOverlay.model.augmentation.Augmentation
addColor, canChangeEditableStatus, canEdit, compareTo, getAugMax, getAugMin, getCManager, getColors, getImportance, getName, isAnnotated, isDiscrete, setAnnotations, setColors, setDiscrete, setEditable, setImportance, setName, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

MarginAugmentation

public MarginAugmentation()

MarginAugmentation

public MarginAugmentation(java.lang.String augName)
Method Detail

setShape

public void setShape(ShapeType sType,
                     ShapeDirection sDir)

isLeft

public boolean isLeft()

setIsLeft

public void setIsLeft(boolean left)

getMarginPosition

public int getMarginPosition()

getType

public java.lang.String getType()
Specified by:
getType in interface ITyped
Overrides:
getType in class Augmentation
Returns:
A succinct String description of the object.

disable

public void disable()
Specified by:
disable in class Augmentation

update

public void update(MetricFile mf,
                   Mapping mm)
Description copied from class: Augmentation
This method updates the display strategy, given an update in the eclipse java editor.

Specified by:
update in class Augmentation
Parameters:
mf - the updated metric file.
mm - the name of the mapping this display applies to.

totChipsOnSide

public int totChipsOnSide()

getShapeType

public ShapeType getShapeType()

getShape

public java.util.Set<int[]> getShape(int lineHeight)

getShapeDirection

public ShapeDirection getShapeDirection()