Main PagePackagesClass TreeIndexHelp
Previous | Next
Frames | No Frames
Summary: Field | Property | Contructor | Method
Detail: Field | Property | Contructor | Method
org.jivesoftware.xiff.data.forms

class FormExtension

Object | +--org.jivesoftware.xiff.data.XMLStanza | +--org.jivesoftware.xiff.data.Extension | +--org.jivesoftware.xiff.data.forms.FormExtension
Implemented Interfaces: IExtension, ISerializable
class FormExtension extends Extension
Implements the base functionality shared by all MUC extensions
  • Author:
    Sean Treadway
  • Since:
    2.0.0

Field Summary

public static CANCEL_TYPE: String
public static ELEMENT: String
public static FIELD_TYPE_BOOLEAN: String
public static FIELD_TYPE_FIXED: String
public static FIELD_TYPE_HIDDEN: String
public static FIELD_TYPE_JID_MULTI: String
public static FIELD_TYPE_JID_SINGLE: String
public static FIELD_TYPE_LIST_MULTI: String
public static FIELD_TYPE_LIST_SINGLE: String
public static FIELD_TYPE_TEXT_MULTI: String
public static FIELD_TYPE_TEXT_PRIVATE: String
public static FIELD_TYPE_TEXT_SINGLE: String
public static NS: String
public static REQUEST_TYPE: String
public static RESULT_TYPE: String
public static SUBMIT_TYPE: String
Fields inherited from class org.jivesoftware.xiff.data.XMLStanza
XMLFactory

Property Summary

public instructions: String (read, write)
Instructions describing what to do with this form
public title: String (read, write)
The title of this form
public type: String (read, write)
The type of form. May be one of the following: FormExtension.REQUEST_TYPE FormExtension.RESULT_TYPE FormExtension.SUBMIT_TYPE FormExtension.CANCEL_TYPE

Constructor

public FormExtension ( parent: XMLNode)

Method Summary

public deserialize ( node: XMLNode ): Boolean
Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.
public static enable ( ): Boolean
public getAllFields ( ): Array
Item interface to array of fields if they are contained in an "item" element
public getAllItems ( ): Array
Item interface to array of fields if they are contained in an "item" element
public getElementName ( ): String
public getFormType ( ): String
This is an accessor to the hidden field type FORM_TYPE easily check what kind of form this is.
public getNS ( ): String
public getReportedFields ( ): Array
Array of fields found in individual items due to a search query result
public removeAllFields ( ): Void
Use this method to remove all fields.
public removeAllItems ( ): Void
Use this method to remove all items.
public serialize ( parent: XMLNode ): Boolean
Called when this extension is being put back on the network. Perform any further serialization for Extensions and items
public setFields ( fieldmap: Object ): Void
Sets the fields given a fieldmap object containing keys of field names and values of value arrays
Methods inherited from class org.jivesoftware.xiff.data.Extension
remove, toString
Methods inherited from class org.jivesoftware.xiff.data.XMLStanza
addTextNode, ensureNode, getNode, replaceTextNode, setNode

Field Documentation

CANCEL_TYPE

public static var CANCEL_TYPE: String

    ELEMENT

    public static var ELEMENT: String

      FIELD_TYPE_BOOLEAN

      public static var FIELD_TYPE_BOOLEAN: String

        FIELD_TYPE_FIXED

        public static var FIELD_TYPE_FIXED: String

          FIELD_TYPE_HIDDEN

          public static var FIELD_TYPE_HIDDEN: String

            FIELD_TYPE_JID_MULTI

            public static var FIELD_TYPE_JID_MULTI: String

              FIELD_TYPE_JID_SINGLE

              public static var FIELD_TYPE_JID_SINGLE: String

                FIELD_TYPE_LIST_MULTI

                public static var FIELD_TYPE_LIST_MULTI: String

                  FIELD_TYPE_LIST_SINGLE

                  public static var FIELD_TYPE_LIST_SINGLE: String

                    FIELD_TYPE_TEXT_MULTI

                    public static var FIELD_TYPE_TEXT_MULTI: String

                      FIELD_TYPE_TEXT_PRIVATE

                      public static var FIELD_TYPE_TEXT_PRIVATE: String

                        FIELD_TYPE_TEXT_SINGLE

                        public static var FIELD_TYPE_TEXT_SINGLE: String

                          NS

                          public static var NS: String

                            REQUEST_TYPE

                            public static var REQUEST_TYPE: String

                              RESULT_TYPE

                              public static var RESULT_TYPE: String

                                SUBMIT_TYPE

                                public static var SUBMIT_TYPE: String

                                  Property Documentation

                                  instructions

                                  public instructions: String (read, write)
                                  Instructions describing what to do with this form

                                    title

                                    public title: String (read, write)
                                    The title of this form

                                      type

                                      public type: String (read, write)
                                      The type of form. May be one of the following: FormExtension.REQUEST_TYPE FormExtension.RESULT_TYPE FormExtension.SUBMIT_TYPE FormExtension.CANCEL_TYPE

                                        Constructor Documentation

                                        FormExtension

                                        public function FormExtension (
                                        parent: XMLNode)

                                          Method Documentation

                                          deserialize

                                          public function deserialize (
                                          node: XMLNode): Boolean
                                          Called when data is retrieved from the XMLSocket, use this method to extract any state into internal state.

                                          enable

                                          public static function enable (
                                          ): Boolean

                                            getAllFields

                                            public function getAllFields (
                                            ): Array
                                            Item interface to array of fields if they are contained in an "item" element
                                            • Returns:
                                              Array of FormFields objects

                                            getAllItems

                                            public function getAllItems (
                                            ): Array
                                            Item interface to array of fields if they are contained in an "item" element
                                            • Returns:
                                              Array containing Arrays of FormFields objects

                                            getElementName

                                            public function getElementName (
                                            ): String

                                            getFormType

                                            public function getFormType (
                                            ): String
                                            This is an accessor to the hidden field type FORM_TYPE easily check what kind of form this is.
                                            • Returns:
                                              String the registered namespace of this form type
                                            • See also:
                                              http://www.jabber.org/jeps/jep-0068.html

                                            getNS

                                            public function getNS (
                                            ): String

                                            getReportedFields

                                            public function getReportedFields (
                                            ): Array
                                            Array of fields found in individual items due to a search query result
                                            • Returns:
                                              Array of FormField objects containing information about the fields in the fields retrieved by getAllItems

                                            removeAllFields

                                            public function removeAllFields (
                                            ): Void
                                            Use this method to remove all fields.

                                              removeAllItems

                                              public function removeAllItems (
                                              ): Void
                                              Use this method to remove all items.

                                                serialize

                                                public function serialize (
                                                parent: XMLNode): Boolean
                                                Called when this extension is being put back on the network. Perform any further serialization for Extensions and items

                                                setFields

                                                public function setFields (
                                                fieldmap: Object): Void
                                                Sets the fields given a fieldmap object containing keys of field names and values of value arrays
                                                • Parameters:
                                                  fieldmap
                                                  		Object in format obj[key:String].value:Array
                                                The documentation was generated from the following file:
                                                • FormExtension.as, Last Modified: 3/10/2005 10:10:10 PM
                                                Copyright © 2004 Mirell Development | Created with AS2Doc | 6/14/2005 9:32:28 AM