Package org.gephi.layout.api
Interface LayoutModel
-
public interface LayoutModelLayout model contains data and flags relative to the layout execution and user interface. There is one model perWorkspacePropertyChangeListenercan be used to receive events about a change in the model.- Author:
- Mathieu Bastian
-
-
Field Summary
Fields Modifier and Type Field Description static StringRUNNINGstatic StringSELECTED_LAYOUT
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddPropertyChangeListener(PropertyChangeListener listener)Add a property change listener for this model.LayoutgetLayout(LayoutBuilder layoutBuilder)Return a layout instance for the givenlayoutBuilder.LayoutBuildergetSelectedBuilder()Returns the builder used for building the currently selected layout ornullif no layout is selected.LayoutgetSelectedLayout()Returns the currently selected layout ornullif no layout is selected.booleanisRunning()Returnstrueif a layout is currently running,falseotherwise.voidremovePropertyChangeListener(PropertyChangeListener listener)Remove listerner.
-
-
-
Field Detail
-
SELECTED_LAYOUT
static final String SELECTED_LAYOUT
- See Also:
- Constant Field Values
-
RUNNING
static final String RUNNING
- See Also:
- Constant Field Values
-
-
Method Detail
-
getSelectedLayout
Layout getSelectedLayout()
Returns the currently selected layout ornullif no layout is selected.
-
getLayout
Layout getLayout(LayoutBuilder layoutBuilder)
Return a layout instance for the givenlayoutBuilder. If saved properties exists, the layout properties values are set. Values are default if it is the first time this layout is built.Use this method instead of
LayoutBuilder.buildLayout()directly.- Parameters:
layoutBuilder- the layout builder- Returns:
- the layout build from
layoutBuilderwith formely saved properties.
-
getSelectedBuilder
LayoutBuilder getSelectedBuilder()
Returns the builder used for building the currently selected layout ornullif no layout is selected.
-
isRunning
boolean isRunning()
Returnstrueif a layout is currently running,falseotherwise.
-
addPropertyChangeListener
void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener for this model. Thelisteneris notified when layout is selected and when running flag change.- Parameters:
listener- a property change listener
-
removePropertyChangeListener
void removePropertyChangeListener(PropertyChangeListener listener)
Remove listerner.- Parameters:
listener- a property change listener.
-
-