%3 ::xowiki::formfield::FormField ::xowiki::formfield::FormField → fc_decode → fc_encode → get_from_name → get_single_spec → interprete_condition CSSclass_list_add add_statistics answer_check=AND answer_check=answer_words answer_check=btwn answer_check=contains answer_check=contains-not answer_check=eq answer_check=ge answer_check=gt answer_check=in answer_check=le answer_check=lt answer_check=match answer_is_correct asWidgetSpec behavior booleanAttributes config_from_spec convert_to_external convert_to_internal describe dict_to_fc dict_to_spec dict_value escape_message_keys field_value handle_transmit_always has_instance_variable init initialize interprete_single_spec is_disabled is_repeat_template_p leaf_components localize make_correct pretty_image pretty_value process_correct_when_modifier remove_omit render render_answer_statistics render_collapsed render_disabled_as_div render_error_msg render_form_widget render_help_text render_input render_item render_localizer render_modal render_result_statistics render_word_statistics repeat repeat_add_label resetBooleanAttributes reset_on_validation_error reset_parameter same_value set_disabled set_feedback set_is_repeat_template stats_record_count validate validation_check value_if_nothing_is_returned_from_form word_statistics ::xo::tdom::Object ::xo::tdom::Object render ::xowiki::formfield::FormField->::xo::tdom::Object ::xowiki::MenuComponent ::xowiki::MenuComponent html_id js_name ::xowiki::MenuComponent->::xo::tdom::Object ::xo::tdom::AttributeManager ::xo::tdom::AttributeManager ::xo::tdom::Object->::xo::tdom::AttributeManager ::xo::OrderedComposite ::xo::OrderedComposite ::xo::tdom::Object->::xo::OrderedComposite ::xowiki::formfield::number ::xowiki::formfield::number initialize render_input ::xowiki::formfield::number->::xowiki::formfield::FormField ::xowiki::formfield::boolean_image ::xowiki::formfield::boolean_image initialize render_input ::xowiki::formfield::boolean_image->::xowiki::formfield::FormField ::xowiki::formfield::omit ::xowiki::formfield::omit render_help_text render_item ::xowiki::formfield::omit->::xowiki::formfield::FormField ::xowiki::formfield::CompoundField ::xowiki::formfield::CompoundField add_component add_statistics check=compound convert_to_external convert_to_internal create_components exists_named_sub_component generate_fieldnames get_component get_compound_value get_named_sub_component get_named_sub_component_value has_instance_variable leaf_components make_correct named_sub_components object pretty_value render_input reset_on_validation_error same_value set_compound_value set_disabled set_is_repeat_template specs_unmodified validate value ::xowiki::formfield::CompoundField->::xowiki::formfield::FormField ::xowiki::formfield::inform ::xowiki::formfield::inform initialize render_help_text render_input ::xowiki::formfield::inform->::xowiki::formfield::FormField ::xowiki::formfield::hidden ::xowiki::formfield::hidden check=signature initialize render_help_text render_item ::xowiki::formfield::hidden->::xowiki::formfield::FormField ::xowiki::formfield::label ::xowiki::formfield::label pretty_value render_input render_item ::xowiki::formfield::label->::xowiki::formfield::FormField ::xowiki::formfield::text ::xowiki::formfield::text add_statistics initialize render_input ::xowiki::formfield::text->::xowiki::formfield::FormField ::xowiki::formfield::range ::xowiki::formfield::range initialize render_input ::xowiki::formfield::range->::xowiki::formfield::FormField ::xowiki::formfield::ShuffleField ::xowiki::formfield::ShuffleField check=options initialize randomized_indices shuffle_options valid_subselection ::xowiki::formfield::ShuffleField->::xowiki::formfield::FormField ::xowiki::formfield::textarea ::xowiki::formfield::textarea add_statistics clear_editor_mixins initialize render_input set_feedback ::xowiki::formfield::textarea->::xowiki::formfield::FormField ::xowiki::formfield::submit_button ::xowiki::formfield::submit_button initialize render_input ::xowiki::formfield::submit_button->::xowiki::formfield::FormField ::xowf::test_item::td_pretty_value ::xowf::test_item::td_pretty_value pretty_value ::xowf::test_item::td_pretty_value->::xowiki::formfield::FormField ::xowf::Property ::xowf::Property get_default_from init wf_context ::xowf::Property->::xowiki::formfield::FormField ::xowiki::formfield::file ::xowiki::formfield::file check=virus content-type convert_to_internal entry_info get_from_value get_old_value initialize label_or_value no_value_provided pretty_value render_input reset_on_validation_error store_file tmpfile value ::xowiki::formfield::file->::xowiki::formfield::FormField ::xowiki::formfield::grade_boundary ::xowiki::formfield::grade_boundary render_input ::xowiki::formfield::grade_boundary->::xowiki::formfield::number ::xowiki::formfield::repeatContainer ::xowiki::formfield::repeatContainer check_nr_components component_item_spec convert_to_internal count_values initialize item_spec pretty_value render_input require_component set_compound_value trim_values validate ::xowiki::formfield::repeatContainer->::xowiki::formfield::CompoundField ::xowiki::formfield::regression_test_mycompound ::xowiki::formfield::regression_test_mycompound initialize ::xowiki::formfield::regression_test_mycompound->::xowiki::formfield::CompoundField ::xowiki::formfield::text_fields ::xowiki::formfield::text_fields answer_is_correct get_text_entry initialize pretty_value render_help_text render_input set_feedback td_pretty_value ::xowiki::formfield::text_fields->::xowiki::formfield::CompoundField ::xowiki::formfield::text_fields->::xowiki::formfield::ShuffleField ::xowiki::formfield::regression_test_compound_with_repeat2 ::xowiki::formfield::regression_test_compound_with_repeat2 initialize ::xowiki::formfield::regression_test_compound_with_repeat2->::xowiki::formfield::CompoundField ::xowiki::formfield::mc_exercise ::xowiki::formfield::mc_exercise convert_to_internal initialize pretty_value render_input ::xowiki::formfield::mc_exercise->::xowiki::formfield::CompoundField ::xowiki::formfield::date ::xowiki::formfield::date convert_to_external get_compound_value initialize pretty_value render_input same_value set_compound_value ::xowiki::formfield::date->::xowiki::formfield::CompoundField ::xowiki::formfield::CalendarField ::xowiki::formfield::CalendarField update_calendar ::xowiki::formfield::CalendarField->::xowiki::formfield::CompoundField ::xowiki::formfield::repeattest ::xowiki::formfield::repeattest initialize ::xowiki::formfield::repeattest->::xowiki::formfield::CompoundField ::xowiki::formfield::mc_alternative ::xowiki::formfield::mc_alternative initialize ::xowiki::formfield::mc_alternative->::xowiki::formfield::CompoundField ::xowiki::formfield::FormGeneratorField ::xowiki::formfield::FormGeneratorField pretty_value render_input ::xowiki::formfield::FormGeneratorField->::xowiki::formfield::CompoundField ::xowiki::formfield::regression_test_compound_with_repeat ::xowiki::formfield::regression_test_compound_with_repeat initialize ::xowiki::formfield::regression_test_compound_with_repeat->::xowiki::formfield::CompoundField ::xowiki::formfield::regression_test_compound_numeric ::xowiki::formfield::regression_test_compound_numeric initialize ::xowiki::formfield::regression_test_compound_numeric->::xowiki::formfield::CompoundField ::xowiki::formfield::comp_correct_when ::xowiki::formfield::comp_correct_when initialize ::xowiki::formfield::comp_correct_when->::xowiki::formfield::CompoundField ::xowiki::formfield::child_pages ::xowiki::formfield::child_pages initialize pretty_value ::xowiki::formfield::child_pages->::xowiki::formfield::label ::xowiki::formfield::current_state ::xowiki::formfield::current_state pretty_value render_input ::xowiki::formfield::current_state->::xowiki::formfield::label ::xowiki::formfield::week ::xowiki::formfield::week initialize ::xowiki::formfield::week->::xowiki::formfield::text ::xowiki::formfield::color ::xowiki::formfield::color initialize ::xowiki::formfield::color->::xowiki::formfield::text ::xowiki::formfield::redirect ::xowiki::formfield::redirect pretty_value ::xowiki::formfield::redirect->::xowiki::formfield::text ::xowiki::formfield::password ::xowiki::formfield::password initialize ::xowiki::formfield::password->::xowiki::formfield::text ::xowiki::formfield::search ::xowiki::formfield::search initialize ::xowiki::formfield::search->::xowiki::formfield::text ::xowiki::formfield::time ::xowiki::formfield::time initialize ::xowiki::formfield::time->::xowiki::formfield::text ::xowiki::formfield::test_item_name ::xowiki::formfield::test_item_name check=name ::xowiki::formfield::test_item_name->::xowiki::formfield::text ::xowiki::formfield::email ::xowiki::formfield::email initialize ::xowiki::formfield::email->::xowiki::formfield::text ::xowiki::formfield::numeric ::xowiki::formfield::numeric answer_check=eq check=numeric convert_to_external convert_to_internal convert_to_internal_value initialize pretty_value render_input ::xowiki::formfield::numeric->::xowiki::formfield::text ::xowiki::formfield::datetime ::xowiki::formfield::datetime initialize ::xowiki::formfield::datetime->::xowiki::formfield::text ::xowiki::formfield::h5date ::xowiki::formfield::h5date initialize ::xowiki::formfield::h5date->::xowiki::formfield::text ::xowiki::formfield::h5time ::xowiki::formfield::h5time initialize ::xowiki::formfield::h5time->::xowiki::formfield::text ::xowiki::formfield::youtube_url ::xowiki::formfield::youtube_url initialize pretty_value ::xowiki::formfield::youtube_url->::xowiki::formfield::text ::xowiki::formfield::image_url ::xowiki::formfield::image_url check=image_check entry_name initialize pretty_value ::xowiki::formfield::image_url->::xowiki::formfield::text ::xowiki::formfield::url ::xowiki::formfield::url check=safe_url initialize pretty_value ::xowiki::formfield::url->::xowiki::formfield::text ::xowiki::formfield::tel ::xowiki::formfield::tel initialize ::xowiki::formfield::tel->::xowiki::formfield::text ::xowiki::formfield::datetime-local ::xowiki::formfield::datetime-local initialize ::xowiki::formfield::datetime-local->::xowiki::formfield::text ::xowiki::formfield::include ::xowiki::formfield::include pretty_value ::xowiki::formfield::include->::xowiki::formfield::text ::xowiki::formfield::localized_text ::xowiki::formfield::localized_text build_message_key_name convert_to_internal escape_message_keys pretty_value render_input ::xowiki::formfield::localized_text->::xowiki::formfield::text ::xowiki::formfield::correct_when ::xowiki::formfield::correct_when check=valid_predicate initialize ::xowiki::formfield::correct_when->::xowiki::formfield::text ::xowiki::formfield::enumeration ::xowiki::formfield::enumeration add_statistics answer_is_correct config_from_category_tree get_labels ggw initialize make_correct pretty_value render_input render_label_classes render_label_text render_result_statistics scores stats_record_detail value_if_nothing_is_returned_from_form ::xowiki::formfield::enumeration->::xowiki::formfield::ShuffleField ::xowiki::formfield::workflow_definition ::xowiki::formfield::workflow_definition as_graph check=workflow pretty_value ::xowiki::formfield::workflow_definition->::xowiki::formfield::textarea ::xowiki::formfield::menuentries ::xowiki::formfield::menuentries pretty_value ::xowiki::formfield::menuentries->::xowiki::formfield::textarea ::xowiki::formfield::code_listing ::xowiki::formfield::code_listing pretty_value ::xowiki::formfield::code_listing->::xowiki::formfield::textarea ::xowiki::formfield::richtext ::xowiki::formfield::richtext check=safe_html editor initialize pretty_value render_richtext_as_div ::xowiki::formfield::richtext->::xowiki::formfield::textarea ::xowiki::formfield::form_constraints ::xowiki::formfield::form_constraints ::xowiki::formfield::form_constraints->::xowiki::formfield::textarea ::xowiki::formfield::import_archive ::xowiki::formfield::import_archive initialize pretty_value ::xowiki::formfield::import_archive->::xowiki::formfield::file ::xowiki::formfield::image ::xowiki::formfield::image pretty_value ::xowiki::formfield::image->::xowiki::formfield::file

Class ::xowiki::formfield::FormField

::xowiki::formfield::FormField[i] create ... \
           [ -CSSclass (default "form-control") ] \
           [ -form_button_CSSclass (default "btn btn-default") ] \
           [ -form_button_wrapper_CSSclass (default "") ] \
           [ -form_help_text_CSSclass (default "help-block") ] \
           [ -form_item_wrapper_CSSclass (default "form-group") ] \
           [ -form_label_CSSclass (default "") ] \
           [ -form_widget_CSSclass (default "") ]

Base FormField class. FormFields are objects, which can be outputted as well in ad_forms or asHTML included in wiki pages. FormFields support: - validation - help_text - error messages - internationalized pretty_values and inherit properties of the original datatypes via slots (e.g. for boolean entries). FormFields can be subclassed to ensure tailor-ability and high reuse. todo: at some later time, this could go into xotcl-core.
Documented Parameters:
language_specific
this parameter decides that the value collected by this formfield should be transparently stored as a message key. The translation language is that of the current package, determined by 'use_connection_locale' package parameter, connection locale and system settings.
Defined in packages/xowiki/tcl/form-field-procs.tcl

Class Relations

  • class: ::xotcl::Class[i]
  • superclass: ::xo::tdom::Object[i]
  • subclass: ::xowiki::formfield::number[i], ::xowiki::formfield::boolean_image[i], ::xowiki::formfield::omit[i], ::xowiki::formfield::CompoundField[i], ::xowiki::formfield::inform[i], ::xowiki::formfield::hidden[i], ::xowiki::formfield::label[i], ::xowiki::formfield::text[i], ::xowiki::formfield::range[i], ::xowiki::formfield::ShuffleField[i], ::xowiki::formfield::textarea[i], ::xowiki::formfield::submit_button[i], ::xowf::test_item::td_pretty_value[i], ::xowf::Property[i], ::xowiki::formfield::file[i]

Methods (to be applied on the object)

  • fc_decode (scripted)

     xowiki::formfield::FormField[i] fc_decode

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_dict_to_xx dict_to_xx (test ) xowiki::formfield::FormField proc fc_decode xowiki::formfield::FormField proc fc_decode test_dict_to_xx->xowiki::formfield::FormField proc fc_decode test_xowiki xowiki (test ) test_xowiki->xowiki::formfield::FormField proc fc_decode

    Testcases:
    dict_to_xx, xowiki
  • fc_encode (scripted)

     xowiki::formfield::FormField[i] fc_encode

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_dict_to_xx dict_to_xx (test ) xowiki::formfield::FormField proc fc_encode xowiki::formfield::FormField proc fc_encode test_dict_to_xx->xowiki::formfield::FormField proc fc_encode test_xowiki xowiki (test ) test_xowiki->xowiki::formfield::FormField proc fc_encode

    Testcases:
    dict_to_xx, xowiki
  • get_from_name (scripted)

  • get_single_spec (scripted)

  • interprete_condition (scripted)

Methods (to be applied on instances)

  • CSSclass (setter)

  • CSSclass_list_add (scripted)

  • add_statistics (scripted)

  • answer (setter)

  • answer_check=AND (scripted)

  • answer_check=answer_words (scripted)

  • answer_check=btwn (scripted)

  • answer_check=contains (scripted)

  • answer_check=contains-not (scripted)

  • answer_check=eq (scripted)

  • answer_check=ge (scripted)

  • answer_check=gt (scripted)

  • answer_check=in (scripted)

  • answer_check=le (scripted)

  • answer_check=lt (scripted)

  • answer_check=match (scripted)

  • answer_is_correct (scripted)

  • asWidgetSpec (scripted)

  • autocomplete (setter)

  • autofocus (setter)

  • behavior (scripted)

  • booleanAttributes (scripted)

  • config_from_spec (scripted)

  • convert_to_external (scripted)

  • convert_to_internal (scripted)

  • correct_when (setter)

  • default (setter)

  • describe (scripted)

  • dict_to_fc (forward)

     <instance of xowiki::formfield::FormField[i]> dict_to_fc

    Partial Call Graph (max 5 caller/called nodes):
    %3 test_create_test_items create_test_items (test ) xowiki::formfield::FormField instproc dict_to_fc xowiki::formfield::FormField instproc dict_to_fc test_create_test_items->xowiki::formfield::FormField instproc dict_to_fc test_xowf xowf (test ) test_xowf->xowiki::formfield::FormField instproc dict_to_fc

    Testcases:
    create_test_items, xowf
  • dict_to_spec (forward)

  • dict_value (forward)

  • disabled (setter)

  • disabled_as_div (setter)

  • display_field (setter)

  • error_msg (setter)

  • escape_message_keys (scripted)

  • feedback_answer_correct (setter)

  • feedback_answer_incorrect (setter)

  • field_value (scripted)

  • form_button_CSSclass (setter)

  • form_button_wrapper_CSSclass (setter)

  • form_help_text_CSSclass (setter)

  • form_item_wrapper_CSSclass (setter)

  • form_label_CSSclass (setter)

  • form_widget_CSSclass (setter)

  • formnovalidate (setter)

  • grading (setter)

  • handle_transmit_always (scripted)

  • has_instance_variable (scripted)

  • help_text (setter)

  • hide_value (setter)

  • id (setter)

  • in_position (setter)

  • init (scripted)

  • initialize (scripted)

  • inline (setter)

  • interprete_single_spec (scripted)

  • is_disabled (scripted)

  • is_repeat_template_p (scripted)

  • label (setter)

  • label_noquote (setter)

  • leaf_components (scripted)

  • locale (setter)

  • localize (scripted)

  • make_correct (scripted)

  • mode (setter)

  • multiple (setter)

  • name (setter)

  • object (setter)

  • pattern (setter)

  • placeholder (setter)

  • pretty_image (scripted)

  • pretty_value (scripted)

  • process_correct_when_modifier (scripted)

  • readonly (setter)

  • remove_omit (scripted)

  • render (scripted)

  • render_answer_statistics (scripted)

  • render_collapsed (scripted)

  • render_disabled_as_div (scripted)

  • render_error_msg (scripted)

  • render_form_widget (scripted)

  • render_help_text (scripted)

  • render_input (scripted)

  • render_item (scripted)

  • render_localizer (scripted)

  • render_modal (scripted)

  • render_result_statistics (scripted)

  • render_word_statistics (scripted)

  • repeat (scripted)

  • repeat_add_label (scripted)

  • required (setter)

  • resetBooleanAttributes (scripted)

  • reset_on_validation_error (scripted)

  • reset_parameter (scripted)

  • same_value (scripted)

  • set_disabled (scripted)

  • set_feedback (scripted)

  • set_is_repeat_template (scripted)

  • show_raw_value (setter)

  • slot (setter)

  • spec (setter)

  • stats_record_count (scripted)

  • style (setter)

  • td_CSSclass (setter)

  • test_item_in_position (setter)

  • test_item_minutes (setter)

  • test_item_points (setter)

  • title (setter)

  • type (setter)

  • validate (scripted)

  • validate_via_ajax (setter)

  • validation_check (scripted)

  • validator (setter)

  • value (setter)

  • value_if_nothing_is_returned_from_form (scripted)

  • word_statistics (scripted)