Contents

module Vedeu

  module Groups

    # Refresh an interface, or collection of interfaces belonging to a
    # group.
    #
    # The interfaces will be refreshed in z-index order, meaning that
    # interfaces with a lower z-index will be drawn first. This means
    # overlapping interfaces will be drawn as specified.
    #
    # @example
    #   Vedeu.trigger(:_refresh_group_, group_name)
    #
    class Refresh

      include Vedeu::Common

      # @param name [String|Symbol] The name of the group to be
      #   refreshed.
      # @return [Array|Vedeu::Error::ModelNotFound] A collection of
      #   the names of interfaces refreshed, or an exception when the
      #   group was not found.
      def self.by_name(name)
        new(name).by_name
      end

      # Return a new instance of Vedeu::Groups::Refresh.
      #
      # @param name [String|Symbol]
      # @return [Vedeu::Groups::Refresh]
      def initialize(name)
        @name = name
      end

      # @return [void]
      def by_name
        Vedeu.timer("Refresh Group: '#{group_name}'".freeze) do
          Vedeu.groups.by_name(group_name).by_zindex.each do |name|
            Vedeu.trigger(:_refresh_view_, name)
          end
        end
      end

      protected

      # @!attribute [r] name
      # @return [String]
      attr_reader :name

      private

      # @raise [Vedeu::Error::MissingRequired] When the name is empty
      #   or nil.
      # @return [String]
      def group_name
        return name if present?(name)

        fail Vedeu::Error::MissingRequired,
             'Cannot refresh group with an empty group name.'.freeze
      end

    end # Refresh

  end # Groups

  # See {file:docs/events/refresh.md#\_refresh_group_}
  Vedeu.bind(:_refresh_group_) do |name|
    Vedeu::Groups::Refresh.by_name(name)
  end

end # Vedeu

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
vedeu-0.6.30	lib/vedeu/groups/refresh.rb