Module: Vedeu::DSL::Text

Included in:

Line, Stream, View, Interfaces::DSL

Defined in:

lib/vedeu/dsl/text.rb

Overview

Provides helper methods for building views.

Instance Method Summary

• #text(value = '', options = {}) ⇒ String (also: #text=, #align, #center, #centre, #left, #right, #align=, #center=, #centre=, #left=, #right=)

  Specify the content for a view.

Instance Method Details

#text(value = '', options = {}) ⇒ String Also known as: text=, align, center, centre, left, right, align=, center=, centre=, left=, right=

Note:

If using the convenience methods; left, centre, center or right, then a specified anchor will be ignored.

Specify the content for a view. Provides the means to align a string (or object responding to ‘to_s`), and add it as a Line or to the Stream.

Examples:

lines do
  centre '...'
end

line do
  right '...'
end

line do
  stream do
    text '...'
  end
end

left 'This will be left aligned.', width: 35
# => 'This will be left aligned.         '

centre 'This will be aligned centrally.', width: 35
# => '  This will be aligned centrally.  '
# centre is also aliased to center

right 'This will be right aligned.', width: 35
# => '        This will be right aligned.'

right 'This will be right aligned.', width: 35,
  anchor: centre

text 'This will be truncated here. More text here.',
  width: 28 # => 'This will be truncated here.'

text 'Padded with hyphens.', width: 25, pad: '-',
  anchor: :right # => '-----Padded with hyphens.'

Parameters:

• value (String|Object) (defaults to: '') —

  A string or object that responds to ‘to_s`.

• options (Hash) (defaults to: {}) —

  Text options.

Options Hash (options):

• :anchor (Symbol) —

  One of ‘:left`, `:centre`/`:center`, or `:right`.

• :width (Integer|NilClass) —

  The width of the text stream to add. If the ‘string` provided is longer than this value, the string will be truncated. If no width is provided in the context of ’lines’, then the interface width is used. If no width is provided in the context of a ‘stream’, then no alignment will occur.

• :pad (String) —

  The character to use to pad the width, by default uses an empty space (0x20). Only when the string is shorter than the specified width.

Returns:

• (String)

# File 'lib/vedeu/dsl/text.rb', line 66

def text(value = '', options = {})
  options.merge!(anchor: __callee__, model: model, client: client)

  Vedeu::Output::Text.add(value, options)
end