Class TextEditBasedChangeGroup

  • Direct Known Subclasses:
    TextEditChangeGroup

    public class TextEditBasedChangeGroup
    extends Object
    This class is a wrapper around a TextEditGroup adding support for marking a group as active and inactive.

    Note: this class is not intended to be extended by clients.

    Since:
    3.2
    See Also:
    TextEditGroup
    Restriction:
    This class is not intended to be subclassed by clients.
    • Constructor Detail

      • TextEditBasedChangeGroup

        public TextEditBasedChangeGroup​(TextEditBasedChange change,
                                        TextEditGroup group)
        Creates new TextEditBasedChangeGroup for the given TextEditBasedChange and TextEditGroup.
        Parameters:
        change - the change owning this text edit change group
        group - the underlying text edit group
    • Method Detail

      • getTextEditChange

        public TextEditBasedChange getTextEditChange()
        Returns the text edit change this group belongs to.
        Returns:
        the text edit change this group belongs to
      • getName

        public String getName()
        Returns the groups's name by forwarding the method to the underlying text edit group.
        Returns:
        the group's name
      • getRegion

        public IRegion getRegion()
        Returns the region covered by the underlying text edit group.
        Returns:
        the region covered by the underlying text edit group
      • getTextEditGroup

        public TextEditGroup getTextEditGroup()
        Returns the underlying text edit group.
        Returns:
        the underlying text edit group
      • getTextEdits

        public TextEdit[] getTextEdits()
        Returns the text edits managed by the underlying text edit group.
        Returns:
        the text edits managed by the underlying text edit group
      • isEnabled

        public boolean isEnabled()
        Returns whether the group is enabled or not.
        Returns:
        true if the group is marked as enabled; false otherwise
      • setEnabled

        public void setEnabled​(boolean enabled)
        Marks the group as enabled or disabled. If a group is marked as disabled the text edits managed by the underlying text edit group aren't executed when performing the text change that owns this group.
        Parameters:
        enabled - true to mark this group as enabled, false to mark it as disabled
      • getGroupCategorySet

        public GroupCategorySet getGroupCategorySet()
        Returns the set of group categories.
        Returns:
        the group categories of this change group