org.onosproject.ui.model.topo

Class UiTopoLayout

java.lang.Object

org.onosproject.ui.model.topo.UiTopoLayout

public class UiTopoLayout
extends Object

Represents a specific "subset" of the UI model of the network topology that a user might wish to view. Backed by a Region.

Constructor Summary

Constructors

Constructor and Description
UiTopoLayout(UiTopoLayoutId id, Region region, UiTopoLayoutId parent) Created a new UI topology layout.

Method Summary

Modifier and Type	Method and Description
UiTopoLayoutId	id() Returns the UI layout identifier.
boolean	isRoot() Returns true if this layout instance is at the top of the hierarchy tree.
UiTopoLayoutId	parent() Returns the parent layout identifier.
Region	region() Returns the backing region with which this layout is associated.
RegionId	regionId() Returns the identifier of the backing region.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UiTopoLayout

public UiTopoLayout(UiTopoLayoutId id,
                    Region region,
                    UiTopoLayoutId parent)

Created a new UI topology layout.

Parameters:

id - layout identifier

region - backing region

parent - identifier of the parent layout

Method Detail

toString

public String toString()

Overrides:

toString in class Object

id

public UiTopoLayoutId id()

Returns the UI layout identifier.

Returns:

identifier of the layout

region

public Region region()

Returns the backing region with which this layout is associated. Note that this may be null (for the root layout).

Returns:

backing region

regionId

public RegionId regionId()

Returns the identifier of the backing region. If this is the default layout, the null-region ID will be returned, otherwise the ID of the backing region for this layout will be returned; null in the case that there is no backing region.

Returns:

backing region identifier

parent

public UiTopoLayoutId parent()

Returns the parent layout identifier.

Returns:

parent layout identifier

isRoot

public boolean isRoot()

Returns true if this layout instance is at the top of the hierarchy tree.

Returns:

true if this is the root layout