yafowil.widget.array 1.8__py3-none-any.whl

yafowil/widget/array/__init__.py

@@ -0,0 +1,37 @@
+from yafowil.base import factory
+from yafowil.utils import entry_point
+import os
+
+
+resourcedir = os.path.join(os.path.dirname(__file__), 'resources')
+js = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'widget.js',
+    'order': 20,
+}]
+default_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'default/widget.css',
+    'order': 20,
+}]
+bootstrap_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'bootstrap/widget.css',
+    'order': 20,
+}]
+plone5_css = [{
+    'group': 'yafowil.widget.array.common',
+    'resource': 'plone5/widget.css',
+    'order': 20,
+}]
+
+
+@entry_point(order=10)
+def register():
+    from yafowil.widget.array import widget  # noqa
+    factory.register_theme('default', 'yafowil.widget.array',
+                           resourcedir, js=js, css=default_css)
+    factory.register_theme('bootstrap', 'yafowil.widget.array',
+                           resourcedir, js=js, css=bootstrap_css)
+    factory.register_theme('plone5', 'yafowil.widget.array',
+                           resourcedir, js=js, css=plone5_css)

yafowil/widget/array/example.py

@@ -0,0 +1,377 @@
+from yafowil.base import factory
+
+
+DOC_ARRAY_WITH_LEAFS = """
+Array with single fields as array entries
+-----------------------------------------
+
+Array containing single field entries. Preset value is expected as list.
+
+.. code-block:: python
+
+    value = ['1', '2', '3']
+    array = factory('#array', value=value, props={
+        'label': 'My Array',
+        'help': 'I am an array',
+        'required': 'Array must at least contain one entry',
+    })
+    array['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'help': 'I am an array entry',
+        'required': 'Entry must not be empty',
+    })
+"""
+
+
+def array_with_leafs():
+    form = factory('fieldset',
+                   name='yafowil.widget.array.array_with_leafs')
+    value = ['1', '2', '3']
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'My Array',
+        'help': 'I am an array',
+        'required': 'Array must at least contain one entry',
+    })
+    arr['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'help': 'I am an array entry',
+        'required': 'Entry must not be empty',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_LEAFS,
+        'title': 'Single field array',
+    }
+
+
+DOC_ARRAY_WITH_COMPOUNDS = """
+Array with compounds as array entries
+-------------------------------------
+
+Array containing compound entries. Preset value is expected as list containing
+dictionaries addressing array child compound fields by key.
+
+.. code-block:: python
+
+    value = [
+        {'f1': 'Value 1.1 F1', 'f2': 'Value 1.2 F2'},
+        {'f1': 'Value 2.1 F1', 'f2': 'Value 2.2 F2'},
+    ]
+    array = factory('#array', value=value, props={
+        'label': 'Compound Array'
+        'required': 'Array must at least contain one entry',
+    })
+    compound = array['compound'] = factory('compound')
+    compound['f1'] = factory('#arrayfield:text', props={
+        'label': 'Field 1',
+    })
+    compound['f2'] = factory('#arrayfield:text', props={
+        'label': 'Field 2',
+        'required': 'Field 2 is required',
+    })
+"""
+
+
+def array_with_compounds():
+    form = factory('fieldset',
+                   name='yafowil.widget.array.array_with_compounds')
+    value = [
+        {'f1': 'Value 1.1 F1', 'f2': 'Value 1.2 F2'},
+        {'f1': 'Value 2.1 F1', 'f2': 'Value 2.2 F2'},
+    ]
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'Compound Array',
+        'required': 'Array must at least contain one entry',
+    })
+    comp = arr['compound'] = factory('compound')
+    comp['f1'] = factory('#arrayfield:text', props={
+        'label': 'Field 1',
+    })
+    comp['f2'] = factory('#arrayfield:text', props={
+        'label': 'Field 2',
+        'required': 'Field 2 is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_COMPOUNDS,
+        'title': 'Compound field array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_LEAFS = """
+Array in array with single fields
+---------------------------------
+
+Array in array containing single field entries. Preset value is a 2-dimensional
+list
+
+.. code-block:: python
+
+    value = [['1', '2'], ['3', '4'], ['5', '6']]
+    array = factory('#array', value=value, props={
+        'label': 'Array',
+        'required': 'Array must at least contain one entry',
+    })
+    subarray = array['subarray'] = factory('error:array', props={
+        'label': 'Subarray',
+        'required': 'Subarray must at least contain one entry',
+    })
+    subarray['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'required': 'Entry must not be empty',
+    })
+"""
+
+
+def array_with_array_with_leafs():
+    form = factory('fieldset',
+                   name='yafowil.widget.array_with_array_with_leafs')
+    value = [['1', '2'], ['3', '4'], ['5', '6']]
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'Array',
+        'required': 'Array must at least contain one entry',
+    })
+    subarr = arr['subarray'] = factory('error:array', props={
+        'label': 'Subarray',
+        'required': 'Subarray must at least contain one entry',
+    })
+    subarr['field'] = factory('#arrayfield:text', props={
+        'label': 'Entry',
+        'required': 'Entry must not be empty',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_LEAFS,
+        'title': 'Single field array in array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_COMPOUNDS = """\
+Array in array with compounds as array entries
+----------------------------------------------
+
+Array in array containing compound entries. Preset value is lists in list
+containing dictionaries addressing inner array child compound fields by key.
+
+.. code-block:: python
+
+    value = [
+        [{
+            'f1': 'Value 0.0 F1',
+            'f2': 'Value 0.0 F2',
+        }, {
+            'f1': 'Value 0.1 F1',
+            'f2': 'Value 0.1 F2',
+        }], [{
+            'f1': 'Value 1.0 F1',
+            'f2': 'Value 1.0 F2',
+        }, {
+            'f1': 'Value 1.1 F1',
+            'f2': 'Value 1.1 F2',
+        }]
+    ]
+    array = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    subarray = array['subarray'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    compound = subarray['comp'] = factory('compound')
+    compound['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    compound['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+"""
+
+
+def array_with_array_with_compounds():
+    form = factory('fieldset',
+                   name='yafowil.widget.array_with_array_with_compounds')
+    value = [
+        [{
+            'f1': 'Value 0.0 F1',
+            'f2': 'Value 0.0 F2',
+        }, {
+            'f1': 'Value 0.1 F1',
+            'f2': 'Value 0.1 F2',
+        }], [{
+            'f1': 'Value 1.0 F1',
+            'f2': 'Value 1.0 F2',
+        }, {
+            'f1': 'Value 1.1 F1',
+            'f2': 'Value 1.1 F2',
+        }]
+    ]
+    arr = form['array'] = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    subarr = arr['subarray'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    comp = subarr['comp'] = factory('compound')
+    comp['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    comp['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_COMPOUNDS,
+        'title': 'Compound array in array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_LEAFS = """\
+3-Dimensional Array with single fields
+--------------------------------------
+
+3-Dimensional array containing single field entries. Preset value is a
+3-dimensional list
+
+.. code-block:: python
+
+    value = [[['1', '2'], ['3']], [['4', '5']]]
+    arr_1 = factory('#array', value=value, props={
+        'label': 'Array 1',
+        'help': 'This is Array 1',
+        'required': 'Array 1 must not be empty',
+    })
+    arr_2 = arr_1['array_2'] = factory('help:error:array', props={
+        'label': 'Array 2',
+        'help': 'This is Array 2',
+        'required': 'Array 2 must not be empty',
+    })
+    arr_3 = arr_2['array_3'] = factory('help:error:array', props={
+        'label': 'Array 3',
+        'help': 'This is Array 3',
+        'required': 'Array 3 must not be empty',
+    })
+    arr_3['field'] = factory('#arrayfield:text', props={
+        'label': 'Text Field',
+        'help': 'This is the text field',
+        'required': 'Text Field is required',
+    })
+"""
+
+
+def array_with_array_with_array_with_leafs():
+    form = factory(
+        'fieldset',
+        name='yafowil.widget.array_with_array_with_array_with_leafs')
+    value = [[['1', '2'], ['3']], [['4', '5']]]
+    arr_1 = form['array_1'] = factory('#array', value=value, props={
+        'label': 'Array 1',
+        'help': 'This is Array 1',
+        'required': 'Array 1 must not be empty',
+    })
+    arr_2 = arr_1['array_2'] = factory('help:error:array', props={
+        'label': 'Array 2',
+        'help': 'This is Array 2',
+        'required': 'Array 2 must not be empty',
+    })
+    arr_3 = arr_2['array_3'] = factory('help:error:array', props={
+        'label': 'Array 3',
+        'help': 'This is Array 3',
+        'required': 'Array 3 must not be empty',
+    })
+    arr_3['textfield'] = factory('#arrayfield:text', props={
+        'label': 'Text Field',
+        'help': 'This is the text field',
+        'required': 'Text Field is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_LEAFS,
+        'title': 'Single fields in 3-dimensional array',
+    }
+
+
+DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_COMPOUNDS = """\
+3-Dimensional Array with compounds
+----------------------------------
+
+3-Dimensional array containing compound entries. Preset value is a
+3-dimensional list containing dictionaries addressing most inner array child
+compound fields by key.
+
+.. code-block:: python
+
+    value = [
+        [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]], [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]]
+    ]
+    arr_1 = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    arr_2 = arr_1['array_2'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    arr_3 = arr_2['array_3'] = factory('array', props={
+        'label': 'Array 3',
+    })
+    compound = arr_3['comp'] = factory('compound')
+    compound['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    compound['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+"""
+
+
+def array_with_array_with_array_with_compounds():
+    form = factory(
+        'fieldset',
+        name='yafowil.widget.array_with_array_with_array_with_compounds')
+    value = [
+        [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]], [[{
+            'f1': 'Value F1',
+            'f2': 'Value F2',
+        }]]]
+    arr_1 = form['array_1'] = factory('#array', value=value, props={
+        'label': 'Array 1',
+    })
+    arr_2 = arr_1['array_2'] = factory('array', props={
+        'label': 'Array 2',
+    })
+    arr_3 = arr_2['array_3'] = factory('array', props={
+        'label': 'Array 3',
+    })
+    comp = arr_3['comp'] = factory('compound')
+    comp['f1'] = factory('#arrayfield:text', props={
+        'label': 'F1',
+    })
+    comp['f2'] = factory('#arrayfield:text', props={
+        'label': 'F2',
+        'required': 'F2 is required',
+    })
+    return {
+        'widget': form,
+        'doc': DOC_ARRAY_WITH_ARRAY_WITH_ARRAY_WITH_COMPOUNDS,
+        'title': 'Compounds in 3-dimensional array',
+    }
+
+
+def get_example():
+    return [
+        array_with_leafs(),
+        array_with_compounds(),
+        array_with_array_with_leafs(),
+        array_with_array_with_compounds(),
+        array_with_array_with_array_with_leafs(),
+        array_with_array_with_array_with_compounds(),
+    ]

yafowil/widget/array/resources/bootstrap/widget.css

@@ -0,0 +1,67 @@
+/* yafowil.widget.array - bootstrap theme styles */
+.icon-plus-sign,
+.icon-minus-sign,
+.icon-circle-arrow-up,
+.icon-circle-arrow-down {
+    display:inline-block;
+    font-family:'Glyphicons Halflings';
+    font-style:normal;
+    font-weight:400;
+    line-height:1;
+    margin-left:2px;
+    position:relative;
+    top:1px;
+}
+.icon-plus-sign:before {
+    content:"";
+}
+.icon-minus-sign:before {
+    content:"";
+}
+.icon-circle-arrow-up:before {
+    content:"";
+}
+.icon-circle-arrow-down:before {
+    content:"";
+}
+.array table {
+    border-radius:4px;
+    margin-bottom:0;
+}
+.array table table {
+    border-right:#ddd 1px solid;
+    margin-top:10px;
+}
+.array table table th {
+    padding-left:0;
+}
+.array td.widget {
+    padding:0 0 10px 0;
+}
+.array td.widget .form-group {
+    margin:0;
+}
+.array th {
+    vertical-align:middle;
+}
+.array th.head_actions,
+.array td.actions {
+    width:5.5em;
+}
+.array_actions {
+    display:inline-block;
+    margin-top:0.6em;
+    padding-right:0.45em;
+    width:5.5em;
+}
+.array_actions a {
+    float:right;
+}
+.array_actions a.array_row_up_disabled,
+.array_actions a.array_row_down_disabled {
+    opacity:0.4;
+    filter:alpha(opacity=40);
+}
+.arraytemplate {
+    display:none;
+}

yafowil/widget/array/resources/default/widget.css

@@ -0,0 +1,65 @@
+/* yafowil.widget.array - default theme styles */
+.arraytemplate {
+    display:none;
+}
+.icon-plus-sign:before {
+    content:"\00a0";
+}
+.icon-minus-sign:before {
+    content: "\00a0";
+}
+.icon-circle-arrow-up:before {
+    content:"\00a0";
+}
+.icon-circle-arrow-down:before {
+    content: "\00a0";
+}
+.array table {
+    border-collapse:collapse;
+    border-top:#ccc 1px solid;
+    border-left:#ccc 1px solid;
+    border-right:#ccc 1px solid;
+    margin-bottom:0.5em;
+}
+.array table th {
+    color:#333;
+    background-color:#ccc;
+}
+.array table tr {
+    border-bottom:#ccc 1px solid;
+}
+.array table td.actions {
+    vertical-align:top;
+}
+.errormessage {
+	color:red;
+	font-size:11px;
+	padding-bottom:2px;
+}
+.array_actions a {
+    line-height:16px;
+    font-size:16px;
+    padding-left:16px;
+    text-decoration:none;
+    float:right;
+    margin-top:1px;
+    border:none !important;
+}
+.array_actions a.array_row_add {
+    background:url('images/icon_add.png') 50% 50% no-repeat;
+}
+.array_actions a.array_row_remove {
+    background:url('images/icon_remove.png') 50% 50% no-repeat;
+}
+.array_actions a.array_row_up {
+    background:url('images/icon_up.png') 50% 50% no-repeat;
+}
+.array_actions a.array_row_up_disabled {
+    background:url('images/icon_up_disabled.png') 50% 50% no-repeat !important;
+}
+.array_actions a.array_row_down {
+    background:url('images/icon_down.png') 50% 50% no-repeat;
+}
+.array_actions a.array_row_down_disabled {
+    background:url('images/icon_down_disabled.png') 50% 50% no-repeat !important;
+}

yafowil/widget/array/resources/plone5/widget.css

@@ -0,0 +1,93 @@
+/* yafowil.widget.array - bootstrap theme styles */
+.array .icon-plus-sign,
+.array .icon-minus-sign,
+.array .icon-circle-arrow-up,
+.array .icon-circle-arrow-down {
+    display:inline-block;
+    font-family:'yafowil-fontello';
+    font-style:normal;
+    font-weight:400;
+    font-variant:normal;
+    text-transform:none;
+    text-decoration:none;
+    text-align:center;
+    line-height:1em;
+    position:relative;
+    top:1px;
+    width:1em;
+    margin-right:2px;
+    margin-left:2px;
+    speak:none;
+    -webkit-font-smoothing:antialiased;
+    -moz-osx-font-smoothing:grayscale;
+}
+.array .icon-plus-sign:before {
+	font-family:'yafowil-fontello';
+    content:"\e800";
+}
+.array .icon-minus-sign:before {
+	font-family:'yafowil-fontello';
+    content:"\e801";
+}
+.array .icon-circle-arrow-up:before {
+	font-family:'yafowil-fontello';
+    content:"\e803";
+}
+.array .icon-circle-arrow-down:before {
+	font-family:'yafowil-fontello';
+    content:"\e802";
+}
+.array table {
+    margin-bottom:0;
+    border:none;
+    background:transparent;
+}
+.array table tr,
+.array table td {
+    border:none;
+}
+.array table th {
+    border:none;
+    border-bottom:#ddd 2px solid;
+}
+.array table table {
+    border-right:#ddd 1px solid;
+    margin-top:10px;
+}
+.array table table th {
+    padding-left:0;
+}
+.array td.widget {
+    padding:0;
+}
+.array td.widget .form-group {
+    margin:0;
+}
+.array th {
+    vertical-align:middle;
+}
+.array th.head_actions,
+.array td.actions {
+    width:6.5em;
+}
+.array_actions {
+    display:inline-block;
+    margin-top:0.6em;
+    padding-right:0.45em;
+    width:6.5em;
+}
+.array_actions a {
+    float:right;
+}
+.array_actions a.array_row_up_disabled,
+.array_actions a.array_row_down_disabled {
+    opacity:0.4;
+    filter:alpha(opacity=40);
+}
+.arraytemplate {
+    display:none;
+}
+.array .field {
+    padding-top:0.5em;
+    margin-bottom:0;
+}