Gephi Toolkit Javadoc

org.gephi.layout.plugin.scale
Class ScaleLayout

java.lang.Object
  extended by org.gephi.layout.plugin.AbstractLayout
      extended by org.gephi.layout.plugin.scale.ScaleLayout
All Implemented Interfaces:
Layout

public class ScaleLayout
extends AbstractLayout
implements Layout

Sample layout that scales the graph.

Author:
Helder Suzuki

Field Summary
 
Fields inherited from class org.gephi.layout.plugin.AbstractLayout
dynamicModel, graphModel
 
Constructor Summary
ScaleLayout(LayoutBuilder layoutBuilder, double scale)
           
 
Method Summary
 void endAlgo()
          Called when the algorithm is finished (canAlgo() returns false).
 LayoutProperty[] getProperties()
          The properties for this layout.
 java.lang.Double getScale()
           
 void goAlgo()
          Run a step in the algorithm, should be called only if canAlgo() returns true.
 void initAlgo()
          initAlgo() is called to initialize the algorithm (prepare to run).
 void resetPropertiesValues()
          Resets the properties values to the default values.
 void setScale(java.lang.Double scale)
           
 
Methods inherited from class org.gephi.layout.plugin.AbstractLayout
canAlgo, getBuilder, isConverged, setConverged, setGraphModel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.gephi.layout.spi.Layout
canAlgo, getBuilder, setGraphModel
 

Constructor Detail

ScaleLayout

public ScaleLayout(LayoutBuilder layoutBuilder,
                   double scale)
Method Detail

initAlgo

public void initAlgo()
Description copied from interface: Layout
initAlgo() is called to initialize the algorithm (prepare to run).

Specified by:
initAlgo in interface Layout

goAlgo

public void goAlgo()
Description copied from interface: Layout
Run a step in the algorithm, should be called only if canAlgo() returns true.

Specified by:
goAlgo in interface Layout

endAlgo

public void endAlgo()
Description copied from interface: Layout
Called when the algorithm is finished (canAlgo() returns false).

Specified by:
endAlgo in interface Layout

getProperties

public LayoutProperty[] getProperties()
Description copied from interface: Layout
The properties for this layout.

Specified by:
getProperties in interface Layout
Returns:
the layout properties

resetPropertiesValues

public void resetPropertiesValues()
Description copied from interface: Layout
Resets the properties values to the default values.

Specified by:
resetPropertiesValues in interface Layout

getScale

public java.lang.Double getScale()
Returns:
the scale

setScale

public void setScale(java.lang.Double scale)
Parameters:
scale - the scale to set

Gephi Toolkit Javadoc