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
Border
options
@return [Table::BorderOptions]
Public Class Methods
Initialize a BorderDSL
@param [Hash] characters
the border characters
@return [undefined]
@api private
# File lib/tty/table/border_dsl.rb, line 32 def initialize(border_opts = nil, &block) @options = TTY::Table::BorderOptions.from(border_opts) yield_or_eval(&block) if block_given? end
Public Instance Methods
Set bottom border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 121 def bottom(value) characters["bottom"] = value end
Set bottom left corner border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 145 def bottom_left(value) characters["bottom_left"] = value end
Set bottom middle border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 133 def bottom_mid(value) characters["bottom_mid"] = value end
Set bottom right corner border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 157 def bottom_right(value) characters["bottom_right"] = value end
Set center border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 229 def center(value) characters["center"] = value end
Set left border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 217 def left(value) characters["left"] = value end
Set middle border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 169 def mid(value) characters["mid"] = value end
Set middle left corner border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 193 def mid_left(value) characters["mid_left"] = value end
Set middle border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 181 def mid_mid(value) characters["mid_mid"] = value end
Set middle right corner border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 205 def mid_right(value) characters["mid_right"] = value end
Set right border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 241 def right(value) characters["right"] = value end
Apply table tuple separator
@param [Symbol] value
the table tuple separator
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 59 def separator(value = (not_set = true)) return options.separator if not_set options.separator = value end
Apply style color to the border
@param [Symbol] value
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
Set top border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 73 def top(value) characters["top"] = value end
Set top left corner border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 97 def top_left(value) characters["top_left"] = value end
Set top middle border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 85 def top_mid(value) characters["top_mid"] = value end
Set top right corner border character
@param [String] value
the character value
@return [undefined]
@api public
# File lib/tty/table/border_dsl.rb, line 109 def top_right(value) characters["top_right"] = value end
Private Instance Methods
Evaluate block
@return [Table]
@api private
# File lib/tty/table/border_dsl.rb, line 252 def yield_or_eval(&block) return unless block block.arity > 0 ? yield(self) : instance_eval(&block) end