Class: Vedeu::Borders::Border Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Presentation, Presentation::Colour, Presentation::Position, Presentation::Styles, Repositories::Model
Defined in:
lib/vedeu/borders/border.rb

Overview

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

Note:

Refer to UTF-8 U+2500 to U+257F for border characters. More details can be found at: en.wikipedia.org/wiki/Box-drawing_character

Provides the mechanism to decorate an interface with a border on all edges, or specific edges. The characters which are used for the border parts (e.g. the corners, verticals and horizontals) can be customised as can the colours and styles.

More information can be found at: Borders

Instance Attribute Summary collapse

Attributes included from Repositories::Model

#repository

Instance Method Summary collapse

Methods included from Presentation::Styles

#render_style, #style, #style=, #style?

Methods included from Presentation::Parent

#parent?

Methods included from Common

#absent?, #array?, #boolean, #boolean?, #empty_value?, #escape?, #falsy?, #hash?, #line_model?, #numeric?, #positionable?, #present?, #snake_case, #stream_model?, #string?, #symbol?, #truthy?, #view_model?

Methods included from Presentation::Position

#position, #position=, #position?, #render_position, #x, #y

Methods included from Presentation::Colour

#background, #background=, #colour, #colour=, #colour?, #foreground, #foreground=, #interface, #named_colour, #named_colour?, #parent_colour, #parent_colour?, #render_colour

Methods included from Presentation

#to_s

Methods included from Repositories::Model

included, #store

Constructor Details

#initialize(attributes = {}) ⇒ Vedeu::Borders::Border

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.

Returns a new instance of Vedeu::Borders::Border.

Parameters:

Options Hash (attributes):

  • bottom_left (String) —

    The bottom left border character.

  • bottom_right (String) —

    The bottom right border character.

  • colour (Hash)
  • enabled (Boolean) —

    Indicate whether the border is to be shown for this interface.

  • horizontal (String) —

    The horizontal border character.

  • left_vertical (String) —

    The left vertical border character.

  • name (String|Symbol) —

    The name of the interface to which this border relates.

  • right_vertical (String) —

    The right vertical border character.

  • style (Vedeu::Presentation::Style)
  • show_bottom (Boolean) —

    Indicate whether the bottom border is to be shown.

  • show_left (Boolean) —

    Indicate whether the left border is to be shown.

  • show_right (Boolean) —

    Indicate whether the right border is to be shown.

  • show_top (Boolean) —

    Indicate whether the top border is to be shown.

  • title (String) —

    An optional title for when the top border is to be shown.

  • caption (String) —

    An optional caption for when the bottom border is to be shown.

  • top_horizontal (String) —

    The top horizontal border character.

  • top_left (String) —

    The top left border character.

  • top_right (String) —

    The top right border character.

  • vertical (String) —

    The vertical border character.



171
172
173
174
175
 
# File 'lib/vedeu/borders/border.rb', line 171

def initialize(attributes = {})
  defaults.merge!(attributes).each do |key, value|
    instance_variable_set("@#{key}", value)
  end
end

Instance Attribute Details

#bottom_horizontal ⇒ Vedeu::Cells::BottomHorizontal

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.

Return the client application configured bottom horizontal cell character, or the default if not set.

Returns:



271
272
273
274
 
# File 'lib/vedeu/borders/border.rb', line 271

def bottom_horizontal
  @bottom_horizontal ||= Vedeu::Cells::BottomHorizontal
                         .new(cell_attributes)
end

#bottom_left ⇒ Vedeu::Cells::BottomLeft

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.

Return the client application configured bottom left cell character, or the default if not set.

Returns:



280
281
282
 
# File 'lib/vedeu/borders/border.rb', line 280

def bottom_left
  @bottom_left ||= Vedeu::Cells::BottomLeft.new(cell_attributes)
end

#bottom_right ⇒ Vedeu::Cells::BottomRight

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.

Return the client application configured bottom right cell character, or the default if not set.

Returns:



288
289
290
 
# File 'lib/vedeu/borders/border.rb', line 288

def bottom_right
  @bottom_right ||= Vedeu::Cells::BottomRight.new(cell_attributes)
end

#caption ⇒ String

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.

Returns An optional caption for when the bottom border is to be shown.

Returns:

  • (String) —

    An optional caption for when the bottom border is to be shown.



48
49
50
 
# File 'lib/vedeu/borders/border.rb', line 48

def caption
  @caption
end

#enabled ⇒ Boolean Also known as: enabled?

Returns Determines whether this border should be rendered.

Returns:

  • (Boolean) —

    Determines whether this border should be rendered.



126
127
128
 
# File 'lib/vedeu/borders/border.rb', line 126

def enabled
  @enabled
end

#horizontal ⇒ String

Returns The character to be used for the horizontal side border.

Returns:

  • (String) —

    The character to be used for the horizontal side border.



53
54
55
 
# File 'lib/vedeu/borders/border.rb', line 53

def horizontal
  @horizontal
end

#left_vertical ⇒ Vedeu::Cells::LeftVertical

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.

Return the client application configured left vertical cell character, or the default if not set.

Returns:



231
232
233
 
# File 'lib/vedeu/borders/border.rb', line 231

def left_vertical
  @left_vertical ||= Vedeu::Cells::LeftVertical.new(cell_attributes)
end

#name ⇒ NilClass|Symbol|String (readonly)

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.

Returns The name of the model, the target model or the name of the associated model.

Returns:

  • (NilClass|Symbol|String) —

    The name of the model, the target model or the name of the associated model.



116
117
118
 
# File 'lib/vedeu/borders/border.rb', line 116

def name
  @name
end

#parent ⇒ Vedeu::Interfaces::Interface|NilClass (readonly)

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.

Returns The interface/ view associated with this border.

Returns:



121
122
123
 
# File 'lib/vedeu/borders/border.rb', line 121

def parent
  @parent
end

#right_vertical ⇒ Vedeu::Cells::RightVertical

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.

Return the client application configured right vertical cell character, or the default if not set.

Returns:



239
240
241
 
# File 'lib/vedeu/borders/border.rb', line 239

def right_vertical
  @right_vertical ||= Vedeu::Cells::RightVertical.new(cell_attributes)
end

#show_bottom ⇒ Boolean Also known as: bottom?

Returns Determines whether the bottom border should be shown.

Returns:

  • (Boolean) —

    Determines whether the bottom border should be shown.



58
59
60
 
# File 'lib/vedeu/borders/border.rb', line 58

def show_bottom
  @show_bottom
end

#show_left ⇒ Boolean Also known as: left?

Returns Determines whether the left border should be shown.

Returns:

  • (Boolean) —

    Determines whether the left border should be shown.



64
65
66
 
# File 'lib/vedeu/borders/border.rb', line 64

def show_left
  @show_left
end

#show_right ⇒ Boolean Also known as: right?

Returns Determines whether the right border should be shown.

Returns:

  • (Boolean) —

    Determines whether the right border should be shown.



70
71
72
 
# File 'lib/vedeu/borders/border.rb', line 70

def show_right
  @show_right
end

#show_top ⇒ Boolean Also known as: top?

Returns Determines whether the top border should be shown.

Returns:

  • (Boolean) —

    Determines whether the top border should be shown.



76
77
78
 
# File 'lib/vedeu/borders/border.rb', line 76

def show_top
  @show_top
end

#title ⇒ String

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.

Returns An optional title for when the top border is to be shown.

Returns:

  • (String) —

    An optional title for when the top border is to be shown.



82
83
84
 
# File 'lib/vedeu/borders/border.rb', line 82

def title
  @title
end

#top_horizontal ⇒ Vedeu::Cells::TopHorizontal

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.

Return the client application configured top horizontal cell character, or the default if not set.

Returns:



247
248
249
 
# File 'lib/vedeu/borders/border.rb', line 247

def top_horizontal
  @top_horizontal ||= Vedeu::Cells::TopHorizontal.new(cell_attributes)
end

#top_left ⇒ Vedeu::Cells::TopLeft

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.

Return the client application configured top left cell character, or the default if not set.

Returns:



255
256
257
 
# File 'lib/vedeu/borders/border.rb', line 255

def top_left
  @top_left ||= Vedeu::Cells::TopLeft.new(cell_attributes)
end

#top_right ⇒ Vedeu::Cells::TopRight

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.

Return the client application configured top right cell character, or the default if not set.

Returns:



263
264
265
 
# File 'lib/vedeu/borders/border.rb', line 263

def top_right
  @top_right ||= Vedeu::Cells::TopRight.new(cell_attributes)
end

#vertical ⇒ String

Returns The character to be used for the vertical side border.

Returns:

  • (String) —

    The character to be used for the vertical side border.



102
103
104
 
# File 'lib/vedeu/borders/border.rb', line 102

def vertical
  @vertical
end

Instance Method Details

#attributes ⇒ Hash<Symbol => Boolean|Hash|NilClass|String|Symbol| Vedeu::Borders::Repository|Vedeu::Presentation::Style>

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.

Returns:



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/vedeu/borders/border.rb', line 179

def attributes
  {
    bottom_horizontal: bottom_horizontal,
    bottom_left:       bottom_left,
    bottom_right:      bottom_right,
    caption:           caption,
    client:            @client,
    colour:            colour,
    enabled:           @enabled,
    horizontal:        @horizontal,
    left_vertical:     left_vertical,
    name:              name,
    parent:            @parent,
    repository:        @repository,
    right_vertical:    right_vertical,
    show_bottom:       @show_bottom,
    show_left:         @show_left,
    show_right:        @show_right,
    show_top:          @show_top,
    style:             style,
    title:             title,
    top_horizontal:    top_horizontal,
    top_left:          top_left,
    top_right:         top_right,
    vertical:          @vertical,
  }
end

#cell_attributes ⇒ Hash<Symbol => void> (private)

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.

Returns:

  • (Hash<Symbol => void>) 


303
304
305
306
307
308
309
 
# File 'lib/vedeu/borders/border.rb', line 303

def cell_attributes
  {
    colour: colour,
    name:   name,
    style:  style,
  }
end

#defaults ⇒ Hash<Symbol => void> (private)

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.

The default options/attributes for a new instance of this class.

Returns:

  • (Hash<Symbol => void>) 


312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/vedeu/borders/border.rb', line 312

def defaults
  {
    bottom_horizontal: nil,
    bottom_left:       nil,
    bottom_right:      nil,
    caption:           '',
    client:            nil,
    colour:            nil,
    enabled:           false,
    horizontal:        Vedeu.esc.horizontal,
    left_vertical:     nil,
    name:              nil,
    parent:            nil,
    repository:        Vedeu.borders,
    right_vertical:    nil,
    show_bottom:       true,
    show_left:         true,
    show_right:        true,
    show_top:          true,
    style:             nil,
    title:             '',
    top_horizontal:    nil,
    top_left:          nil,
    top_right:         nil,
    vertical:          Vedeu.esc.vertical,
  }
end

#deputy(client = nil) ⇒ Vedeu::Borders::DSL

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.

Returns a DSL instance responsible for defining the DSL methods of this model.

Parameters:

  • client (Object|NilClass) (defaults to: nil) —

    The client binding represents the client application object that is currently invoking a DSL method. It is required so that we can send messages to the client application object should we need to.

Returns:



223
224
225
 
# File 'lib/vedeu/borders/border.rb', line 223

def deputy(client = nil)
  Vedeu::Borders::DSL.new(self, client)
end