Class: Vedeu::Cells::Cursor Private

Inherits:
Empty
  • Object
show all
Defined in:
lib/vedeu/cells/cursor.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.

Provides the position and visibility escape sequence for a Vedeu::Cursors::Cursor

Instance Attribute Summary

Attributes inherited from Empty

#name, #value

Instance Method Summary collapse

Methods inherited from Empty

#as_html, #border, #eql?, #geometry, #interface, #text, #to_ast

Methods included from Repositories::Defaults

#initialize, #validate

Methods included from Vedeu::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::Styles

#name, #parent, #render_style, #style=

Methods included from Presentation::Position

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

Methods included from Presentation::Colour

#background=, #colour=, #colour?, #foreground=, #name, #named_colour, #named_colour?, #parent, #parent_colour, #parent_colour?, #render_colour

Instance Method Details

#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>) 


55
56
57
 
# File 'lib/vedeu/cells/cursor.rb', line 55

def defaults
  super.merge!(position: Vedeu::Geometries::Position.new(1, 1))
end

#null ⇒ NilClass Also known as: background, colour, foreground, 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:

  • (NilClass) 


15
16
17
 
# File 'lib/vedeu/cells/cursor.rb', line 15

def null
  nil
end

#to_h ⇒ Hash<void> Also known as: to_hash

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 an empty hash as most escape sequences won’t make sense as JSON.

Returns:

  • (Hash<void>) 


27
28
29
 
# File 'lib/vedeu/cells/cursor.rb', line 27

def to_h
  {}.merge!(position.to_h).merge!(value: value)
end

#to_html(_options = {}) ⇒ 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.

Return an empty string as most escape sequences won’t make sense as HTML.

Parameters:

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

    Ignored.

Returns:

  • (String) 


37
38
39
 
# File 'lib/vedeu/cells/cursor.rb', line 37

def to_html(_options = {})
  ''
end

#to_s ⇒ String Also known as: to_str

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:

  • (String) 


42
43
44
 
# File 'lib/vedeu/cells/cursor.rb', line 42

def to_s
  "#{position}#{value}"
end

#type ⇒ Symbol

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:

  • (Symbol) 


48
49
50
 
# File 'lib/vedeu/cells/cursor.rb', line 48

def type
  :cursor
end