class TTY::Table::BorderDSL

A class responsible for bulding and modifying border

Used internally by {Table::Border} to allow for building custom border through DSL @api private

Attributes

options[R]

Border options

@return [Table::BorderOptions]

Public Class Methods

new(characters = nil, &block) click to toggle source

Initialize a BorderDSL

@param [Hash] characters

the border characters

@return [undefined]

@api private

# File lib/tty/table/border_dsl.rb, line 31
def initialize(characters = nil, &block)
  @options = TTY::Table::BorderOptions.new
  @options.characters = characters if characters
  yield_or_eval(&block) if block_given?
end

Public Instance Methods

bottom(value) click to toggle source

Set bottom border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 118
def bottom(value)
  options.characters['bottom'] = value
end

bottom_left(value) click to toggle source

Set bottom left corner border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 142
def bottom_left(value)
  options.characters['bottom_left'] = value
end

bottom_mid(value) click to toggle source

Set bottom middle border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 130
def bottom_mid(value)
  options.characters['bottom_mid'] = value
end

bottom_right(value) click to toggle source

Set bottom right corner border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 154
def bottom_right(value)
  options.characters['bottom_right'] = value
end

center(value) click to toggle source

Set center border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 226
def center(value)
  options.characters['center'] = value
end

left(value) click to toggle source

Set left border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 214
def left(value)
  options.characters['left'] = value
end

mid(value) click to toggle source

Set middle border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 166
def mid(value)
  options.characters['mid'] = value
end

mid_left(value) click to toggle source

Set middle left corner border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 190
def mid_left(value)
  options.characters['mid_left'] = value
end

mid_mid(value) click to toggle source

Set middle border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 178
def mid_mid(value)
  options.characters['mid_mid'] = value
end

mid_right(value) click to toggle source

Set middle right corner border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 202
def mid_right(value)
  options.characters['mid_right'] = value
end

right(value) click to toggle source

Set right border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 238
def right(value)
  options.characters['right'] = value
end

separator(value) click to toggle source

Apply table tuple separator

@param [Symbol] separator

the table tuple separator

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 58
def separator(value)
  value ? options.separator = value : options.separator
end

style(value = (not_set = true)) click to toggle source

Apply style color to the border

@param [Symbol] style

the style color for the border

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 45
def style(value = (not_set = true))
  return options.style if not_set
  options.style = value
end

top(value) click to toggle source

Set top border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 70
def top(value)
  options.characters['top'] = value
end

top_left(value) click to toggle source

Set top left corner border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 94
def top_left(value)
  options.characters['top_left'] = value
end

top_mid(value) click to toggle source

Set top middle border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 82
def top_mid(value)
  options.characters['top_mid'] = value
end

top_right(value) click to toggle source

Set top right corner border character

@param [String] value

the character value

@return [undefined]

@api public

# File lib/tty/table/border_dsl.rb, line 106
def top_right(value)
  options.characters['top_right'] = value
end