com.github.beothorn.html.common

Class GlobalAttributes

java.lang.Object

com.github.beothorn.html.common.GlobalAttributes

public class GlobalAttributes
extends Object

Global attributes are attributes common to all HTML elements; they can be used on all elements, though the attributes may have no effect on some elements.
Reference on developer.mozilla.org

Author:

lucas

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalAttributes.Direction

Constructor Summary

Constructors

Constructor and Description
GlobalAttributes()

Method Summary

Modifier and Type	Method and Description
static Attribute	accessKey(char keyboardShortcut) The accesskey global attribute provides a hint for generating a keyboard shortcut for the current element.
static List<Attribute>	attrs(Attribute... props)
static Attribute	className(String className) Is a space-separated list of the classes of the element.
static Attribute	contentEditable(boolean editable) The contenteditable global attribute is an enumerated attribute indicating if the element should be editable by the user.
static Attribute	contextMenu(String id) The contextmenu global attribute is the id of a The HTML <menu> element represents a group of commands that a user can perform or activate.
static Attribute	data(String name, String value) Forms a class of attributes, called custom data attributes, that allow proprietary information to be exchanged between the HTML and its DOM representation that may be used by scripts.
static Attribute	dir(GlobalAttributes.Direction dir) The dir global attribute is an enumerated attribute indicates the directionality of the element's text.
static Attribute	hidden(boolean hidden) The hidden global attribute is a Boolean attribute indicating that the element is not yet, or is no longer, relevant.
static Attribute	id(String id) Defines a unique identifier (ID) which must be unique in the whole document.
static Attribute	lang(String lang) The lang global attribute participates in defining the language of the element, the language that is non-editable elements are written in or the language that the editable elements should be written in.
static Attribute	style(String style) The style global attribute contains CSS styling declarations to be applied to the element.
static Attribute	tabIndex(int tabindex) The tabindex global attribute is an integer indicating if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position.
static Attribute	title(String title) The title global attribute contains a text representing advisory information related to the element it belongs to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GlobalAttributes

public GlobalAttributes()

Method Detail

attrs

public static List<Attribute> attrs(Attribute... props)

accessKey

public static Attribute accessKey(char keyboardShortcut)

The accesskey global attribute provides a hint for generating a keyboard shortcut for the current element. This attribute consists of a space-separated list of characters (one single Unicode code point). The browser uses the first one that exists on the computer keyboard layout.

The operation to activate the accesskey depends on browser and its platform.

Reference on developer.mozilla.org

Parameters:

keyboardShortcut - value

Returns:

value

className

public static Attribute className(String className)

Is a space-separated list of the classes of the element. Classes allows CSS and JavaScript to select and access specific elements via the class selectors or functions like the method Document.getElementsByClassName().
Reference on developer.mozilla.org

Parameters:

className - value

Returns:

value

contentEditable

public static Attribute contentEditable(boolean editable)

The contenteditable global attribute is an enumerated attribute indicating if the element should be editable by the user. If so, the browser modifies its widget to allow editing.
Reference on developer.mozilla.org

Parameters:

editable - value

Returns:

value

contextMenu

public static Attribute contextMenu(String id)

The contextmenu global attribute is the id of a The HTML <menu> element represents a group of commands that a user can perform or activate. This includes both list menus, which might appear across the top of a screen, as well as context menus, such as those that might appear underneath a button after it has been clicked. <menu> to use as the contextual menu for this element.

A context menu is a menu that appears upon user interaction, such as a right-click. HTML5 now allows us to customize this menu. Here are some implementation examples, including nested menus.

Reference on developer.mozilla.org

Parameters:

id - value

Returns:

value

data

public static Attribute data(String name,
                             String value)

Forms a class of attributes, called custom data attributes, that allow proprietary information to be exchanged between the HTML and its DOM representation that may be used by scripts. All such custom data are available via the HTMLElement interface of the element the attribute is set on. The HTMLElement.dataset property gives access to them.
Reference on developer.mozilla.org

Parameters:

name - value

value - value

Returns:

value

dir

public static Attribute dir(GlobalAttributes.Direction dir)

The dir global attribute is an enumerated attribute indicates the directionality of the element's text. It can have the following values:

• ltr, which means left to right and is to be used for languages that are written from the left to the right (like English);
• rtl, which means right to left and is to be used for languages that are written from the right to the left (like Arabic);
• auto, which let the user agent decides. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then apply that directionality to the whole element.

Reference on developer.mozilla.org

Parameters:

dir - value

Returns:

value

hidden

public static Attribute hidden(boolean hidden)

The hidden global attribute is a Boolean attribute indicating that the element is not yet, or is no longer, relevant. For example, it can be used to hide elements of the page that can't be used until the login process has been completed. Browsers won't render elements with the hidden attribute set.

The hidden attribute must not be used to hide content that could legitimately be shown in another presentation. For example, it is incorrect to use hidden to hide panels in a tabbed dialog, because the tabbed interface is merely a kind of overflow presentation — one could equally well just show all the form controls in one big page with a scrollbar. It is similarly incorrect to use this attribute to hide content just from one presentation — if something is marked hidden, it is hidden from all presentations, including, for instance, screen readers.

Hidden elements shouldn't be linked from non-hidden elements and elements that are descendants of a hidden element are still active, which means that script elements can still execute and form elements can still submit.

Reference on developer.mozilla.org

Parameters:

hidden - value

Returns:

value

id

public static Attribute id(String id)

Defines a unique identifier (ID) which must be unique in the whole document. Its purpose is to identify the element when linking (using a fragment identifier), scripting, or styling (with CSS).
Reference on developer.mozilla.org

Parameters:

id - value

Returns:

value

lang

public static Attribute lang(String lang)

The lang global attribute participates in defining the language of the element, the language that is non-editable elements are written in or the language that the editable elements should be written in. The tag contains one single entry value in the format defined in the Tags for Identifying Languages (BCP47) IETF document. If the tag content is the empty string the language is set to unknown; if the tag content is not valid, regarding BCP47, it is set to invalid.

Even if the lang attribute is set, it may not be taken into account, as the xml:lang attribute has priority.

For the CSS pseudo-class :lang, The :lang CSS pseudo-class matches elements based on the language the element is determined to be in. In HTML, the language is determined by a combination of the lang attribute, the <meta> element, and possibly by information from the protocol (such as HTTP headers). For other document types there may be other document methods for determining the language. two invalid language names are different if their names are different.

Reference on developer.mozilla.org

Parameters:

lang - value

Returns:

value

style

public static Attribute style(String style)

The style global attribute contains CSS styling declarations to be applied to the element. Note that it is recommended for styles to be defined in a separate file or files. This attribute and the <style> The HTML <style> element contains style information for a document, or part of a document. By default, the style instructions written inside that element are expected to be CSS. element have mainly the purpose of allowing for quick styling, for example for testing purposes.

Reference on developer.mozilla.org

Parameters:

style - value

Returns:

value

tabIndex

public static Attribute tabIndex(int tabindex)

The tabindex global attribute is an integer indicating if the element can take input focus (is focusable), if it should participate to sequential keyboard navigation, and if so, at what position. It can take several values:

• a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;
• 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;
• a positive value means should be focusable and reachable via sequential keyboard navigation; its relative order is defined by the value of the attribute: the sequential follow the increasing number of the tabindex. If several elements share the same tabindex, their relative order follows their relative position in the document.

An element with a 0 value, an invalid value, or no tabindex value should be placed after elements with a positive tabindex in the sequential keyboard navigation order.

Reference on developer.mozilla.org

Parameters:

tabindex - value

Returns:

value

title

public static Attribute title(String title)

The title global attribute contains a text representing advisory information related to the element it belongs to. Such information can typically, but not necessarily, be presented to the user as a tooltip.
Reference on developer.mozilla.org

Parameters:

title - value

Returns:

value