77 lines
2.6 KiB
Python
77 lines
2.6 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
import copy
|
|
|
|
from django.forms.utils import flatatt
|
|
|
|
|
|
class HTMLElement(object):
|
|
"""A generic base class that gracefully handles html-style attributes."""
|
|
def __init__(self):
|
|
self.attrs = getattr(self, "attrs", {})
|
|
self.classes = getattr(self, "classes", [])
|
|
|
|
def get_default_classes(self):
|
|
"""Returns an iterable of default classes which should be combined with
|
|
any other declared classes.
|
|
"""
|
|
return []
|
|
|
|
def get_default_attrs(self):
|
|
"""Returns a dict of default attributes which should be combined with
|
|
other declared attributes.
|
|
"""
|
|
return {}
|
|
|
|
def get_final_attrs(self, classes=True):
|
|
"""Returns a dict containing the final attributes of this element
|
|
which will be rendered.
|
|
"""
|
|
final_attrs = copy.copy(self.get_default_attrs())
|
|
final_attrs.update(self.attrs)
|
|
if classes:
|
|
final_attrs['class'] = self.get_final_css()
|
|
else:
|
|
final_attrs.pop('class', None)
|
|
|
|
return final_attrs
|
|
|
|
def get_final_css(self):
|
|
"""Returns a final css class concatenated string."""
|
|
default = " ".join(self.get_default_classes())
|
|
defined = self.attrs.get('class', '')
|
|
additional = " ".join(getattr(self, "classes", []))
|
|
non_empty = [test for test in (defined, default, additional) if test]
|
|
final_classes = " ".join(non_empty).strip()
|
|
return final_classes
|
|
|
|
@property
|
|
def attr_string(self):
|
|
"""Returns a flattened string of HTML attributes based on the
|
|
``attrs`` dict provided to the class.
|
|
"""
|
|
return flatatt(self.get_final_attrs())
|
|
|
|
@property
|
|
def attr_string_nc(self):
|
|
"""Returns a flattened string of HTML attributes based on the
|
|
``attrs`` dict provided to the class.
|
|
"""
|
|
return flatatt(self.get_final_attrs(False))
|
|
|
|
@property
|
|
def class_string(self):
|
|
"""Returns a list of class name of HTML Element in string."""
|
|
classes_str = " ".join(self.classes)
|
|
return classes_str
|