Class: NattyUI::Wrapper::Progress

Inherits:

Element

• Object
• Element
• NattyUI::Wrapper::Progress

Includes:

ProgressAttributes, ValueAttributes

Defined in:

lib/natty-ui/wrapper/progress.rb

Overview

An Element displaying a progression.

See Also:

• Features#progress

Instance Attribute Summary

• #completed? ⇒ Boolean included from ProgressAttributes readonly

  Whether the task completed successfully.

• #failed? ⇒ Boolean included from ProgressAttributes readonly

  Whether the task failed.

• #info ⇒ String^? included from ValueAttributes

  Current information.

• #max_value ⇒ Float^? included from ValueAttributes readonly

  Maximum value.

• #value ⇒ Float included from ValueAttributes

  Current value.

Instance Method Summary

• #step(increment = 1) ⇒ Wrapper::Element included from ValueAttributes

  Increase the value by given amount.

Instance Attribute Details

#completed? ⇒ Boolean (readonly) Originally defined in module ProgressAttributes

Returns whether the task completed successfully.

Returns:

• (Boolean) —

  whether the task completed successfully

#failed? ⇒ Boolean (readonly) Originally defined in module ProgressAttributes

Returns whether the task failed.

Returns:

• (Boolean) —

  whether the task failed

#info ⇒ String^? Originally defined in module ValueAttributes

Returns current information.

Returns:

• (String, nil) —

  current information

#max_value ⇒ Float^? (readonly) Originally defined in module ValueAttributes

Maximum value.

Returns:

• (Float) —

  maximum value

• (nil) —

  when no max_value was configured

#value ⇒ Float Originally defined in module ValueAttributes

Returns current value.

Returns:

• (Float) —

  current value

Instance Method Details

#step(increment = 1) ⇒ Wrapper::Element Originally defined in module ValueAttributes

Increase the value by given amount.

Parameters:

• increment (#to_f) (defaults to: 1) —

  value increment

Returns:

• (Wrapper::Element) —

  itself