Class: RailsAjax::Configuration
- Inherits:
-
Object
- Object
- RailsAjax::Configuration
- Defined in:
- lib/rails-ajax/configuration.rb
Overview
Class used to configure and store the configuration of RailsAjax
Instance Attribute Summary collapse
-
#DebugAlerts ⇒ Object
readonly
Debug alerts ?.
-
#Enabled ⇒ Object
readonly
Indicate if RailsAjax is enabled.
-
#FlashContainers ⇒ Object
readonly
The flash containers.
-
#MainContainer ⇒ Object
readonly
The main container.
Instance Method Summary collapse
-
#debug_alerts(iSwitch) ⇒ Object
Do we activate debugging alerts ?.
-
#enable(iSwitch) ⇒ Object
Do we activate RailsAjax ?.
-
#flash_containers(iMapSelectors) ⇒ Object
Define the flash containers.
-
#initialize ⇒ Configuration
constructor
Constructor.
-
#main_container(iSelector) ⇒ Object
Define the main container.
Constructor Details
#initialize ⇒ Configuration
Constructor
32 33 34 35 36 37 38 |
# File 'lib/rails-ajax/configuration.rb', line 32 def initialize # Set default values here @Enabled = true @MainContainer = 'body' @FlashContainers = {} @DebugAlerts = false end |
Instance Attribute Details
#DebugAlerts ⇒ Object (readonly)
Debug alerts ?
Boolean
29 30 31 |
# File 'lib/rails-ajax/configuration.rb', line 29 def DebugAlerts @DebugAlerts end |
#Enabled ⇒ Object (readonly)
Indicate if RailsAjax is enabled
Boolean
14 15 16 |
# File 'lib/rails-ajax/configuration.rb', line 14 def Enabled @Enabled end |
#FlashContainers ⇒ Object (readonly)
The flash containers
map< Symbol, String >
24 25 26 |
# File 'lib/rails-ajax/configuration.rb', line 24 def FlashContainers @FlashContainers end |
#MainContainer ⇒ Object (readonly)
The main container
String
19 20 21 |
# File 'lib/rails-ajax/configuration.rb', line 19 def MainContainer @MainContainer end |
Instance Method Details
#debug_alerts(iSwitch) ⇒ Object
Do we activate debugging alerts ?
- Parameters
-
iSwitch (Boolean): Do we activate debugging alerts ?
68 69 70 |
# File 'lib/rails-ajax/configuration.rb', line 68 def debug_alerts(iSwitch) @DebugAlerts = iSwitch end |
#enable(iSwitch) ⇒ Object
Do we activate RailsAjax ?
- Parameters
-
iSwitch (Boolean): Do we activate RailsAjax ?
44 45 46 |
# File 'lib/rails-ajax/configuration.rb', line 44 def enable(iSwitch) @Enabled = iSwitch end |
#flash_containers(iMapSelectors) ⇒ Object
Define the flash containers
- Parameters
-
iMapSelectors (map<Symbol,String>): The map of selectors, per flash message type (:alert, :noticeā¦)
60 61 62 |
# File 'lib/rails-ajax/configuration.rb', line 60 def flash_containers(iMapSelectors) @FlashContainers.merge!(iMapSelectors) end |
#main_container(iSelector) ⇒ Object
Define the main container
- Parameters
-
iSelector (String): Selector used to identify the container
52 53 54 |
# File 'lib/rails-ajax/configuration.rb', line 52 def main_container(iSelector) @MainContainer = iSelector end |