|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.nwoods.jgo.layout.JGoAutoLayout
JGoAutoLayout provides a common super-class for auto-layout algorithms. The key aspects of an auto-layout algorithm are an input JGoDocument, an input JGoNetwork and a performLayout method.
Constructor Summary | |
JGoAutoLayout()
Constructs an AutoLayout with null values for its network, and document. |
|
JGoAutoLayout(JGoDocument doc)
Constructs an AutoLayout with the given document, and a JGoNetwork representing all top-level objects in that document. |
|
JGoAutoLayout(JGoDocument doc,
JGoNetwork network)
Constructs an AutoLayout with the given document and network. |
|
JGoAutoLayout(JGoSelection sel)
Constructs an AutoLayout with a JGoNetwork representing all top-level objects in the given selection, and the selection's corresponding JGoDocument. |
Method Summary | |
JGoDocument |
getDocument()
Returns the AutoLayout's JGoDocument. |
JGoNetwork |
getNetwork()
Returns the AutoLayout's JGoNetwork. |
abstract void |
performLayout()
Performs auto-layout. |
void |
progressUpdate(double progress)
The function progressUpdate can be called at specific times in the layout routine to indicate progress through the layout. |
void |
setDocument(JGoDocument d)
Sets the AutoLayout's JGoDocument to d. |
void |
setNetwork(JGoNetwork n)
Sets the AutoLayout's JGoNetwork to n. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public JGoAutoLayout()
public JGoAutoLayout(JGoDocument doc)
doc
- the JGoDocument containing the JGoObjects to layoutpublic JGoAutoLayout(JGoSelection sel)
sel
- the JGoSelection containing the JGoObjects to layoutpublic JGoAutoLayout(JGoDocument doc, JGoNetwork network)
doc
- the JGoDocument containing the JGoObjects to layoutnetwork
- the JGoNetwork representation of the JGoObjects to layoutMethod Detail |
public abstract void performLayout()
public void progressUpdate(double progress)
progress
- a double between 0.0 and 1.0.public JGoDocument getDocument()
public void setDocument(JGoDocument d)
d
- the new value for the documentpublic JGoNetwork getNetwork()
public void setNetwork(JGoNetwork n)
n
- the new value for the network
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |