Class: TTY::Table::BorderDSL

Inherits:
Object
  • Object
show all
Extended by:
Delegatable
Defined in:
lib/tty/table/border_dsl.rb

Overview

A class responsible for bulding and modifying border

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Delegatable

delegatable_method

Constructor Details

#initialize(characters = nil, &block) ⇒ undefined

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initialize a BorderDSL

Parameters:

  • characters (Hash) (defaults to: nil) —

    the border characters



22
23
24
25
26
 
# File 'lib/tty/table/border_dsl.rb', line 22

def initialize(characters=nil, &block)
  @options = TTY::Table::BorderOptions.new
  @options.characters = characters if characters
  yield_or_eval &block if block_given?
end

Instance Attribute Details

#options ⇒ Object (readonly)

Returns the value of attribute options.



10
11
12
 
# File 'lib/tty/table/border_dsl.rb', line 10

def options
  @options
end

Instance Method Details

#bottom(value) ⇒ undefined

Set bottom border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


108
109
110
 
# File 'lib/tty/table/border_dsl.rb', line 108

def bottom(value)
  options.characters['bottom'] = value
end

#bottom_left(value) ⇒ undefined

Set bottom left corner border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


132
133
134
 
# File 'lib/tty/table/border_dsl.rb', line 132

def bottom_left(value)
  options.characters['bottom_left'] = value
end

#bottom_mid(value) ⇒ undefined

Set bottom middle border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


120
121
122
 
# File 'lib/tty/table/border_dsl.rb', line 120

def bottom_mid(value)
  options.characters['bottom_mid'] = value
end

#bottom_right(value) ⇒ undefined

Set bottom right corner border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


144
145
146
 
# File 'lib/tty/table/border_dsl.rb', line 144

def bottom_right(value)
  options.characters['bottom_right'] = value
end

#center(value) ⇒ undefined

Set center border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


216
217
218
 
# File 'lib/tty/table/border_dsl.rb', line 216

def center(value)
  options.characters['center'] = value
end

#left(value) ⇒ undefined

Set left border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


204
205
206
 
# File 'lib/tty/table/border_dsl.rb', line 204

def left(value)
  options.characters['left'] = value
end

#mid(value) ⇒ undefined

Set middle border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


156
157
158
 
# File 'lib/tty/table/border_dsl.rb', line 156

def mid(value)
  options.characters['mid'] = value
end

#mid_left(value) ⇒ undefined

Set middle left corner border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


180
181
182
 
# File 'lib/tty/table/border_dsl.rb', line 180

def mid_left(value)
  options.characters['mid_left'] = value
end

#mid_mid(value) ⇒ undefined

Set middle border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


168
169
170
 
# File 'lib/tty/table/border_dsl.rb', line 168

def mid_mid(value)
  options.characters['mid_mid'] = value
end

#mid_right(value) ⇒ undefined

Set middle right corner border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


192
193
194
 
# File 'lib/tty/table/border_dsl.rb', line 192

def mid_right(value)
  options.characters['mid_right'] = value
end

#right(value) ⇒ undefined

Set right border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


228
229
230
 
# File 'lib/tty/table/border_dsl.rb', line 228

def right(value)
  options.characters['right'] = value
end

#separator(value) ⇒ undefined

Apply table tuple separator

Parameters:

  • separator (Symbol) —

    the table tuple separator

Returns:

  • (undefined) 


48
49
50
 
# File 'lib/tty/table/border_dsl.rb', line 48

def separator(value)
  options.separator = value
end

#style(value) ⇒ undefined

Apply style color to the border

Parameters:

  • style (Symbol) —

    the style color for the border

Returns:

  • (undefined) 


36
37
38
 
# File 'lib/tty/table/border_dsl.rb', line 36

def style(value)
  options.style = value
end

#top(value) ⇒ undefined

Set top border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


60
61
62
 
# File 'lib/tty/table/border_dsl.rb', line 60

def top(value)
  options.characters['top'] = value
end

#top_left(value) ⇒ undefined

Set top left corner border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


84
85
86
 
# File 'lib/tty/table/border_dsl.rb', line 84

def top_left(value)
  options.characters['top_left'] = value
end

#top_mid(value) ⇒ undefined

Set top middle border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


72
73
74
 
# File 'lib/tty/table/border_dsl.rb', line 72

def top_mid(value)
  options.characters['top_mid'] = value
end

#top_right(value) ⇒ undefined

Set top right corner border character

Parameters:

  • value (String) —

    the character value

Returns:

  • (undefined) 


96
97
98
 
# File 'lib/tty/table/border_dsl.rb', line 96

def top_right(value)
  options.characters['top_right'] = value
end