org.gephi.layout.plugin.noverlap

Class NoverlapLayout

java.lang.Object

org.gephi.layout.plugin.AbstractLayout

org.gephi.layout.plugin.noverlap.NoverlapLayout

All Implemented Interfaces:

Layout, LongTask

public class NoverlapLayout
extends AbstractLayout
implements Layout, LongTask

Author:

Mathieu Jacomy

Constructor Summary

Constructors

Constructor and Description
NoverlapLayout(LayoutBuilder layoutBuilder)

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancel the task.
void	endAlgo() Called when the algorithm is finished (canAlgo() returns false).
Double	getMargin()
LayoutProperty[]	getProperties() The properties for this layout.
Double	getRatio()
Double	getSpeed()
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	setMargin(Double margin)
void	setProgressTicket(ProgressTicket progressTicket) Set the progress ticket for the long task.
void	setRatio(Double ratio)
void	setSpeed(Double speed)

Methods inherited from class org.gephi.layout.plugin.AbstractLayout

canAlgo, ensureSafeLayoutNodePositions, getBuilder, isConverged, setConverged, setGraphModel

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gephi.layout.spi.Layout

canAlgo, getBuilder, setGraphModel

Constructor Detail

NoverlapLayout

public NoverlapLayout(LayoutBuilder layoutBuilder)

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

getSpeed

public Double getSpeed()

setSpeed

public void setSpeed(Double speed)

getRatio

public Double getRatio()

setRatio

public void setRatio(Double ratio)

getMargin

public Double getMargin()

setMargin

public void setMargin(Double margin)

cancel

public boolean cancel()

Description copied from interface: LongTask

Cancel the task. Returns true if the task has been sucessfully cancelled, false otherwise.

Specified by:

cancel in interface LongTask

Returns:

true if the task has been sucessfully cancelled, false otherwise

setProgressTicket

public void setProgressTicket(ProgressTicket progressTicket)

Description copied from interface: LongTask

Set the progress ticket for the long task. Can't be null.

Specified by:

setProgressTicket in interface LongTask

Parameters:

progressTicket - the progress ticket for this task