Class RosterGroup

java.lang.Object
jmri.beans.UnboundBean
jmri.beans.Bean
jmri.jmrit.roster.rostergroup.RosterGroup
All Implemented Interfaces:
BeanInterface, PropertyChangeFirer, PropertyChangeProvider, RosterObject

public class RosterGroup
extends Bean
implements RosterObject
A RosterGroup object contains information about groupings of entries within the Roster. This object allows groups to be manipulated as Java beans.
  • Constructor Details

  • Method Details

    • getEntries

      Get the list of entries associated with this group.
      Returns:
      the list of entries or an empty list.
    • getName

      public String getName()
      Get the RosterGroup's name. Use getDisplayName() to get the name to be displayed to a user.
      Returns:
      the name
      See Also:
      getDisplayName()
    • setName

      public void setName​(String newName)
      Set the RosterGroup's name, changing it in every entry associated with the roster.
      Parameters:
      newName - the new name
    • getDisplayName

      Description copied from interface: RosterObject
      Get the formatted single-line String for displaying the object.
      Specified by:
      getDisplayName in interface RosterObject
      Returns:
      a formatted name
    • canEdit

      public boolean canEdit()
      Flag indicating that this RosterGroup can be edited by the user. The default implementation always returns true.
      Returns:
      true if the group can be edited.
    • canDelete

      public boolean canDelete()
      Flag indicating that this RosterGroup can be deleted by the user. The default implementation always returns true.
      Returns:
      true if the group can be deleted.
    • canCopy

      public boolean canCopy()
      Flag indicating that this RosterGroup can be duplicated by the user. The default implementation always returns true.
      Returns:
      true if the group can be copied.
    • canChangeContents

      public boolean canChangeContents()
      Flag indicating that the contents of this RosterGroup can be changed by the user. The default implementation always returns true.
      Returns:
      true if entries in this group can be changed.