org.onosproject.ui

Class UiView

java.lang.Object

org.onosproject.ui.UiView

Direct Known Subclasses:

UiViewHidden

public class UiView
extends java.lang.Object

Represents a user interface view addition.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UiView.Category Designates the navigation menu category.

Constructor Summary

Constructors

Constructor and Description
UiView(UiView.Category category, java.lang.String id, java.lang.String label) Creates a new user interface view descriptor.
UiView(UiView.Category category, java.lang.String id, java.lang.String label, java.lang.String iconId) Creates a new user interface view descriptor.
UiView(UiView.Category category, java.lang.String id, java.lang.String label, java.lang.String iconId, java.lang.String helpPageUrl) Creates a new user interface view descriptor.

Method Summary

Modifier and Type	Method and Description
UiView.Category	category() Returns the navigation category.
boolean	equals(java.lang.Object obj)
int	hashCode()
java.lang.String	helpPageUrl() Returns the help page URL for a specific view.
java.lang.String	iconId() Returns the icon identifier.
java.lang.String	id() Returns the view identifier.
java.lang.String	label() Returns the view label.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UiView

public UiView(UiView.Category category,
              java.lang.String id,
              java.lang.String label)

Creates a new user interface view descriptor. The navigation item will appear in the navigation menu under the specified category.

Parameters:

category - view category

id - view identifier

label - view label

UiView

public UiView(UiView.Category category,
              java.lang.String id,
              java.lang.String label,
              java.lang.String iconId)

Creates a new user interface view descriptor. The navigation item will appear in the navigation menu under the specified category, with the specified icon adornment.

Note: see the glyphMapping structure in icon.js for valid icon identifiers.

Parameters:

category - view category

id - view identifier

label - view label

iconId - icon id

UiView

public UiView(UiView.Category category,
              java.lang.String id,
              java.lang.String label,
              java.lang.String iconId,
              java.lang.String helpPageUrl)

Creates a new user interface view descriptor. The navigation item will appear in the navigation menu under the specified category, with the specified icon adornment and specified help page.

Note: see the glyphMapping structure in icon.js for valid icon identifiers.

Parameters:

category - view category

id - view identifier

label - view label

iconId - icon id

helpPageUrl - help page URL

Method Detail

category

public UiView.Category category()

Returns the navigation category.

Returns:

navigation category

id

public java.lang.String id()

Returns the view identifier.

Returns:

view ID

label

public java.lang.String label()

Returns the view label.

Returns:

view label

iconId

public java.lang.String iconId()

Returns the icon identifier.

Returns:

icon ID

helpPageUrl

public java.lang.String helpPageUrl()

Returns the help page URL for a specific view.

Returns:

help page URL

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object