public class Highlights
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
Highlights.Amount
A notion of amount.
|
Constructor and Description |
---|
Highlights() |
Modifier and Type | Method and Description |
---|---|
Highlights |
add(DeviceHighlight dh)
Adds highlighting information for a device.
|
Highlights |
add(HostHighlight hh)
Adds highlighting information for a host.
|
Highlights |
add(LinkHighlight lh)
Adds highlighting information for a link.
|
Highlights |
delay(int ms)
Sets the number of milliseconds to delay processing of highlights
events on the client side.
|
int |
delayMs()
Return the delay for the highlight event.
|
java.util.Collection<DeviceHighlight> |
devices()
Returns the collection of device highlights.
|
DeviceHighlight |
getDevice(java.lang.String id)
Returns the device highlight for the given device identifier,
or null if no match.
|
HostHighlight |
getHost(java.lang.String id)
Returns the host highlight for the given host identifier,
or null if no match.
|
LinkHighlight |
getLink(java.lang.String id)
Returns the link highlight for the given link identifier,
or null if no match.
|
NodeHighlight |
getNode(java.lang.String id)
Returns the node highlight (device or host) for the given element
identifier, or null if no match.
|
java.util.Collection<HostHighlight> |
hosts()
Returns the collection of host highlights.
|
java.util.Collection<LinkHighlight> |
links()
Returns the collection of link highlights.
|
Highlights |
subdueAllElse(Highlights.Amount amount)
Marks the amount by which all other elements (devices, hosts, links)
not explicitly referenced here will be "subdued" visually.
|
Highlights.Amount |
subdueLevel()
Returns the amount by which all other elements not explicitly
referenced here should be "subdued".
|
public Highlights delay(int ms)
ms
- milliseconds to delaypublic int delayMs()
public Highlights add(DeviceHighlight dh)
dh
- device highlightpublic Highlights add(HostHighlight hh)
hh
- host highlightpublic Highlights add(LinkHighlight lh)
lh
- link highlightpublic Highlights subdueAllElse(Highlights.Amount amount)
amount
- amount to subdue other elementspublic java.util.Collection<DeviceHighlight> devices()
public java.util.Collection<HostHighlight> hosts()
public java.util.Collection<LinkHighlight> links()
public Highlights.Amount subdueLevel()
public NodeHighlight getNode(java.lang.String id)
id
- element identifierpublic DeviceHighlight getDevice(java.lang.String id)
id
- device identifierpublic HostHighlight getHost(java.lang.String id)
id
- host identifierpublic LinkHighlight getLink(java.lang.String id)
id
- link identifier