Class: Jabber::Dataforms::XDataField

     # File lib/xmpp4r/dataforms/x/data.rb, line 113
113:       def initialize(var=nil, type=nil)
114:         super()
115:         self.var = var
116:         self.type = type
117:       end

label()

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 119
119:       def label
120:         attributes['label']
121:       end

label=(s)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 123
123:       def label=(s)
124:         attributes['label'] = s
125:       end

options()

Get the options (in a Data Form with type=‘form’)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 222
222:       def options
223:         res = {}
224:         each_element('option') { |e|
225:           value = nil
226:           e.each_element('value') { |ve| value = ve.text }
227:           res[value] = e.attributes['label']
228:         }
229:         res
230:       end

options=(hsh)

Set the options

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 234
234:       def options=(hsh)
235:         delete_elements('option')
236:         hsh.each { |value,label|
237:           o = add(REXML::Element.new('option'))
238:           o.attributes['label'] = label
239:           o.add(REXML::Element.new('value')).text = value
240:         }
241:       end

required=(r)

Set if this field is required

r:	[true] or [false]

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 194
194:       def required=(r)
195:         delete_elements('required')
196:         if r
197:           add REXML::Element.new('required')
198:         end
199:       end

required?()

Is this field required (has the <required/> child)?

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 185
185:       def required?
186:         res = false
187:         each_element('required') { res = true }
188:         res
189:       end

type()

Type of this field

result:

* :boolean

:fixed
:hidden
:jid_multi
:jid_single
:list_multi
:list_single
:text_multi
:text_private
:text_single
nil

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 149
149:       def type
150:         case attributes['type']
151:           when 'boolean' then :boolean
152:           when 'fixed' then :fixed
153:           when 'hidden' then :hidden
154:           when 'jid-multi' then :jid_multi
155:           when 'jid-single' then :jid_single
156:           when 'list-multi' then :list_multi
157:           when 'list-single' then :list_single
158:           when 'text-multi' then :text_multi
159:           when 'text-private' then :text_private
160:           when 'text-single' then :text_single
161:           else nil
162:         end
163:       end

type=(t)

Set the type of this field (see type)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 167
167:       def type=(t)
168:         case t
169:           when :boolean then attributes['type'] = 'boolean'
170:           when :fixed then attributes['type'] = 'fixed'
171:           when :hidden then attributes['type'] = 'hidden'
172:           when :jid_multi then attributes['type'] = 'jid-multi'
173:           when :jid_single then attributes['type'] = 'jid-single'
174:           when :list_multi then attributes['type'] = 'list-multi'
175:           when :list_single then attributes['type'] = 'list-single'
176:           when :text_multi then attributes['type'] = 'text-multi'
177:           when :text_private then attributes['type'] = 'text-private'
178:           when :text_single then attributes['type'] = 'text-single'
179:           else attributes['type'] = nil
180:         end
181:       end

values()

Get the values (in a Data Form with type=‘submit’)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 203
203:       def values
204:         res = []
205:         each_element('value') { |e|
206:           res << e.text
207:         }
208:         res
209:       end

values=(ary)

Set the values

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 213
213:       def values=(ary)
214:         delete_elements('value')
215:         ary.each { |v|
216:           add(REXML::Element.new('value')).text = v
217:         }
218:       end

var()

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 127
127:       def var
128:         attributes['var']
129:       end

var=(s)

[Source]

     # File lib/xmpp4r/dataforms/x/data.rb, line 131
131:       def var=(s)
132:         attributes['var'] = s
133:       end

Methods

Public Class methods

Public Instance methods