Package com.inductiveautomation.ignition.gateway.web.nav

Record Class MenuAction

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.web.nav.MenuAction

Record Components:

title - The text to be displayed in the menu

description - Tooltip text to be displayed when hovering over the menu item

component - The component to be displayed when the menu item is clicked

showForInactiveCollection - Should this menu item be shown for inactive collections

public record MenuAction(String title, String description, WebUiComponent component, Boolean showForInactiveCollection)
extends Record

A menu action is an entry in the "hamburger" menu displayed for items in a data grid.

Constructor Summary

Constructors

Constructor	Description
MenuAction(String title, String description, WebUiComponent component)
MenuAction(String title, String description, WebUiComponent component, Boolean showForInactiveCollection)	Creates an instance of a MenuAction record class.

Method Summary

Modifier and Type	Method	Description
WebUiComponent	component()	Returns the value of the component record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Boolean	showForInactiveCollection()	Returns the value of the showForInactiveCollection record component.
String	title()	Returns the value of the title record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

MenuAction

public MenuAction(String title,
 String description,
 WebUiComponent component)

MenuAction

public MenuAction(String title,
 String description,
 WebUiComponent component,
 Boolean showForInactiveCollection)

Creates an instance of a MenuAction record class.

Parameters:

title - the value for the title record component

description - the value for the description record component

component - the value for the component record component

showForInactiveCollection - the value for the showForInactiveCollection record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

title

public String title()

Returns the value of the title record component.

Returns:

the value of the title record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

component

public WebUiComponent component()

Returns the value of the component record component.

Returns:

the value of the component record component

showForInactiveCollection

public Boolean showForInactiveCollection()

Returns the value of the showForInactiveCollection record component.

Returns:

the value of the showForInactiveCollection record component