net.bootsfaces.component.link.Link Maven / Gradle / Ivy
/**
* Copyright 2014-17 by Riccardo Massera (TheCoder4.Eu) and Stephan Rauh (http://www.beyondjava.net).
*
* This file is part of BootsFaces.
*
* 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.
*/
package net.bootsfaces.component.link;
import jakarta.faces.context.FacesContext;
import jakarta.faces.event.AbortProcessingException;
import jakarta.faces.event.ComponentSystemEvent;
import jakarta.faces.event.ListenerFor;
import jakarta.faces.event.ListenersFor;
import jakarta.faces.event.PostAddToViewEvent;
import jakarta.faces.component.FacesComponent;
import net.bootsfaces.component.ajax.IAJAXComponent2;
import net.bootsfaces.component.navLink.NavLink;
import net.bootsfaces.listeners.AddResourcesListener;
/** This class holds the attributes of <b:link />. */
@ListenersFor({ @ListenerFor(systemEventClass = PostAddToViewEvent.class) })
@FacesComponent("net.bootsfaces.component.link.Link")
public class Link extends NavLink implements IAJAXComponent2 {
public Link() {
super();
}
public void processEvent(ComponentSystemEvent event) throws AbortProcessingException {
if (isAutoUpdate()) {
if (FacesContext.getCurrentInstance().isPostback()) {
FacesContext.getCurrentInstance().getPartialViewContext().getRenderIds().add(getClientId());
}
super.processEvent(event);
}
}
protected enum PropertyKeys {
active, ajax, autoUpdate, binding, colLg, colMd, colSm, colXs, contentClass, contentStyle, delay, disabled, display, fragment, header, hidden, href, icon, iconAlign, iconAwesome, iconBrand, iconFlip, iconInverse, iconLight, iconPulse, iconRegular, iconRotate, iconSize, iconSolid, iconSpin, immediate, includeViewParams, largeScreen, look, mediumScreen, offset, offsetLg, offsetMd, offsetSm, offsetXs, onblur, onchange, onclick, oncomplete, ondblclick, onerror, onfocus, onkeydown, onkeypress, onkeyup, onmousedown, onmousemove, onmouseout, onmouseover, onmouseup, onselect, onsuccess, outcome, process, smallScreen, span, style, styleClass, tabindex, target, tinyScreen, tooltip, tooltipContainer, tooltipDelay, tooltipDelayHide, tooltipDelayShow, tooltipPosition, update, visible;
String toString;
PropertyKeys(String toString) {
this.toString = toString;
}
PropertyKeys() {
}
public String toString() {
return ((this.toString != null) ? this.toString : super.toString());
}
}
/**
* Adds the active state to the link.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isActive() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.active, false);
}
/**
* Adds the active state to the link.
* Usually this method is called internally by the JSF engine.
*/
public void setActive(boolean _active) {
getStateHelper().put(PropertyKeys.active, _active);
}
/**
* Whether the Button submits the form with AJAX.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isAjax() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.ajax, false);
}
/**
* Whether the Button submits the form with AJAX.
* Usually this method is called internally by the JSF engine.
*/
public void setAjax(boolean _ajax) {
getStateHelper().put(PropertyKeys.ajax, _ajax);
}
/**
* Setting this flag updates the widget on every AJAX request.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isAutoUpdate() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.autoUpdate, false);
}
/**
* Setting this flag updates the widget on every AJAX request.
* Usually this method is called internally by the JSF engine.
*/
public void setAutoUpdate(boolean _autoUpdate) {
getStateHelper().put(PropertyKeys.autoUpdate, _autoUpdate);
}
/**
* An EL expression referring to a server side UIComponent instance in a backing bean.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public jakarta.faces.component.UIComponent getBinding() {
return (jakarta.faces.component.UIComponent) getStateHelper().eval(PropertyKeys.binding);
}
/**
* An EL expression referring to a server side UIComponent instance in a backing bean.
* Usually this method is called internally by the JSF engine.
*/
public void setBinding(jakarta.faces.component.UIComponent _binding) {
getStateHelper().put(PropertyKeys.binding, _binding);
}
/**
* Integer value to specify how many columns to span on large screens (≥1200 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getColLg() {
return (String) getStateHelper().eval(PropertyKeys.colLg, "-1");
}
/**
* Integer value to specify how many columns to span on large screens (≥1200 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setColLg(String _colLg) {
getStateHelper().put(PropertyKeys.colLg, _colLg);
}
/**
* Integer value to specify how many columns to span on medium screens (≥992 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getColMd() {
return (String) getStateHelper().eval(PropertyKeys.colMd, "-1");
}
/**
* Integer value to specify how many columns to span on medium screens (≥992 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setColMd(String _colMd) {
getStateHelper().put(PropertyKeys.colMd, _colMd);
}
/**
* Integer value to specify how many columns to span on small screens (≥768p pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getColSm() {
return (String) getStateHelper().eval(PropertyKeys.colSm, "-1");
}
/**
* Integer value to specify how many columns to span on small screens (≥768p pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setColSm(String _colSm) {
getStateHelper().put(PropertyKeys.colSm, _colSm);
}
/**
* Integer value to specify how many columns to span on tiny screens (≤ 767 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getColXs() {
return (String) getStateHelper().eval(PropertyKeys.colXs, "-1");
}
/**
* Integer value to specify how many columns to span on tiny screens (≤ 767 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setColXs(String _colXs) {
getStateHelper().put(PropertyKeys.colXs, _colXs);
}
/**
* content-class is optional: if specified, the content (i.e. the anchor tag) will be displayed with this specific class
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getContentClass() {
return (String) getStateHelper().eval(PropertyKeys.contentClass);
}
/**
* content-class is optional: if specified, the content (i.e. the anchor tag) will be displayed with this specific class
* Usually this method is called internally by the JSF engine.
*/
public void setContentClass(String _contentClass) {
getStateHelper().put(PropertyKeys.contentClass, _contentClass);
}
/**
* Inline style of the content area (i.e the anchor tag).
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getContentStyle() {
return (String) getStateHelper().eval(PropertyKeys.contentStyle);
}
/**
* Inline style of the content area (i.e the anchor tag).
* Usually this method is called internally by the JSF engine.
*/
public void setContentStyle(String _contentStyle) {
getStateHelper().put(PropertyKeys.contentStyle, _contentStyle);
}
/**
* Delays the AJAX request.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getDelay() {
return (String) getStateHelper().eval(PropertyKeys.delay);
}
/**
* Delays the AJAX request.
* Usually this method is called internally by the JSF engine.
*/
public void setDelay(String _delay) {
getStateHelper().put(PropertyKeys.delay, _delay);
}
/**
* Boolean value to specify if the button is disabled.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isDisabled() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.disabled, false);
}
/**
* Boolean value to specify if the button is disabled.
* Usually this method is called internally by the JSF engine.
*/
public void setDisabled(boolean _disabled) {
getStateHelper().put(PropertyKeys.disabled, _disabled);
}
/**
* If you use the "visible" attribute, the value of this attribute is added. Legal values: block, inline, inline-block. Default: block.
* @return Returns the value of the attribute, or "block", if it hasn't been set by the JSF file.
*/
public String getDisplay() {
return (String) getStateHelper().eval(PropertyKeys.display, "block");
}
/**
* If you use the "visible" attribute, the value of this attribute is added. Legal values: block, inline, inline-block. Default: block.
* Usually this method is called internally by the JSF engine.
*/
public void setDisplay(String _display) {
getStateHelper().put(PropertyKeys.display, _display);
}
/**
* The fragment that is to be appended to the target URL. The # separator is applied automatically and needs not be included.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getFragment() {
return (String) getStateHelper().eval(PropertyKeys.fragment);
}
/**
* The fragment that is to be appended to the target URL. The # separator is applied automatically and needs not be included.
* Usually this method is called internally by the JSF engine.
*/
public void setFragment(String _fragment) {
getStateHelper().put(PropertyKeys.fragment, _fragment);
}
/**
* If present, this element is rendered as Header in a menu with the text specified by this attribute value: all other attributes will be ignored.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getHeader() {
return (String) getStateHelper().eval(PropertyKeys.header);
}
/**
* If present, this element is rendered as Header in a menu with the text specified by this attribute value: all other attributes will be ignored.
* Usually this method is called internally by the JSF engine.
*/
public void setHeader(String _header) {
getStateHelper().put(PropertyKeys.header, _header);
}
/**
* This column is hidden on a certain screen size and below. Legal values: lg, md, sm, xs.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getHidden() {
return (String) getStateHelper().eval(PropertyKeys.hidden);
}
/**
* This column is hidden on a certain screen size and below. Legal values: lg, md, sm, xs.
* Usually this method is called internally by the JSF engine.
*/
public void setHidden(String _hidden) {
getStateHelper().put(PropertyKeys.hidden, _hidden);
}
/**
* Specifies the URL of the page the link goes to.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getHref() {
return (String) getStateHelper().eval(PropertyKeys.href);
}
/**
* Specifies the URL of the page the link goes to.
* Usually this method is called internally by the JSF engine.
*/
public void setHref(String _href) {
getStateHelper().put(PropertyKeys.href, _href);
}
/**
* Navigation Link Icon, can be one of the Bootstrap's Glyphicons icon names. Alignment can be specified with the icon-align attribute.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getIcon() {
return (String) getStateHelper().eval(PropertyKeys.icon);
}
/**
* Navigation Link Icon, can be one of the Bootstrap's Glyphicons icon names. Alignment can be specified with the icon-align attribute.
* Usually this method is called internally by the JSF engine.
*/
public void setIcon(String _icon) {
getStateHelper().put(PropertyKeys.icon, _icon);
}
/**
* Alignment can be right or left.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getIconAlign() {
return (String) getStateHelper().eval(PropertyKeys.iconAlign);
}
/**
* Alignment can be right or left.
* Usually this method is called internally by the JSF engine.
*/
public void setIconAlign(String _iconAlign) {
getStateHelper().put(PropertyKeys.iconAlign, _iconAlign);
}
/**
* Navigation Link Font Awesome Icon, can be one of the Font Awesome icon names. Alignment can be specified with the icon-align attribute.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getIconAwesome() {
return (String) getStateHelper().eval(PropertyKeys.iconAwesome);
}
/**
* Navigation Link Font Awesome Icon, can be one of the Font Awesome icon names. Alignment can be specified with the icon-align attribute.
* Usually this method is called internally by the JSF engine.
*/
public void setIconAwesome(String _iconAwesome) {
AddResourcesListener.setNeedsFontsAwesome(this);
getStateHelper().put(PropertyKeys.iconAwesome, _iconAwesome);
}
/**
* Use the free brand font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconBrand() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconBrand, false);
}
/**
* Use the free brand font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* Usually this method is called internally by the JSF engine.
*/
public void setIconBrand(boolean _iconBrand) {
if (_iconBrand) {
AddResourcesListener.setFontAwesomeVersion(5, this);
}
getStateHelper().put(PropertyKeys.iconBrand, _iconBrand);
}
/**
* Flip the icon: can be H (horizontal) or V (vertical).
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getIconFlip() {
return (String) getStateHelper().eval(PropertyKeys.iconFlip);
}
/**
* Flip the icon: can be H (horizontal) or V (vertical).
* Usually this method is called internally by the JSF engine.
*/
public void setIconFlip(String _iconFlip) {
getStateHelper().put(PropertyKeys.iconFlip, _iconFlip);
}
/**
* Switch the icon from black-on-white to white-on-black.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconInverse() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconInverse, false);
}
/**
* Switch the icon from black-on-white to white-on-black.
* Usually this method is called internally by the JSF engine.
*/
public void setIconInverse(boolean _iconInverse) {
getStateHelper().put(PropertyKeys.iconInverse, _iconInverse);
}
/**
* Use the paid 'light' font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconLight() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconLight, false);
}
/**
* Use the paid 'light' font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* Usually this method is called internally by the JSF engine.
*/
public void setIconLight(boolean _iconLight) {
if (_iconLight) {
AddResourcesListener.setFontAwesomeVersion(5, this);
}
getStateHelper().put(PropertyKeys.iconLight, _iconLight);
}
/**
* Boolean value: if true the icon will rotate with 8 discrete steps.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconPulse() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconPulse, false);
}
/**
* Boolean value: if true the icon will rotate with 8 discrete steps.
* Usually this method is called internally by the JSF engine.
*/
public void setIconPulse(boolean _iconPulse) {
getStateHelper().put(PropertyKeys.iconPulse, _iconPulse);
}
/**
* Use the paid 'regular' font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconRegular() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconRegular, false);
}
/**
* Use the paid 'regular' font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* Usually this method is called internally by the JSF engine.
*/
public void setIconRegular(boolean _iconRegular) {
if (_iconRegular) {
AddResourcesListener.setFontAwesomeVersion(5, this);
}
getStateHelper().put(PropertyKeys.iconRegular, _iconRegular);
}
/**
* Rotate 90 degrees the icon: Can be L,R.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getIconRotate() {
return (String) getStateHelper().eval(PropertyKeys.iconRotate);
}
/**
* Rotate 90 degrees the icon: Can be L,R.
* Usually this method is called internally by the JSF engine.
*/
public void setIconRotate(String _iconRotate) {
getStateHelper().put(PropertyKeys.iconRotate, _iconRotate);
}
/**
* Icon Size: legal values are lg (=133%), 2x, 3x, 4x, 5x. If you're using Fontawesome 5, also 6x, 7x, 8x, 9, 10x, xs (=75%), and sm (=87.5%) are allowed.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getIconSize() {
return (String) getStateHelper().eval(PropertyKeys.iconSize);
}
/**
* Icon Size: legal values are lg (=133%), 2x, 3x, 4x, 5x. If you're using Fontawesome 5, also 6x, 7x, 8x, 9, 10x, xs (=75%), and sm (=87.5%) are allowed.
* Usually this method is called internally by the JSF engine.
*/
public void setIconSize(String _iconSize) {
getStateHelper().put(PropertyKeys.iconSize, _iconSize);
}
/**
* Use the free font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconSolid() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconSolid, false);
}
/**
* Use the free font of FontAwesome 5. As a side effect, every FontAwesome icon on the same page is switched to FontAwesome 5.2.0. By default, the icon set is the older version 4.7.0.
* Usually this method is called internally by the JSF engine.
*/
public void setIconSolid(boolean _iconSolid) {
if (_iconSolid) {
AddResourcesListener.setFontAwesomeVersion(5, this);
}
getStateHelper().put(PropertyKeys.iconSolid, _iconSolid);
}
/**
* Boolean value: if true the icon will spin.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIconSpin() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.iconSpin, false);
}
/**
* Boolean value: if true the icon will spin.
* Usually this method is called internally by the JSF engine.
*/
public void setIconSpin(boolean _iconSpin) {
getStateHelper().put(PropertyKeys.iconSpin, _iconSpin);
}
/**
* Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase. Default is false.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isImmediate() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.immediate, false);
}
/**
* Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase. Default is false.
* Usually this method is called internally by the JSF engine.
*/
public void setImmediate(boolean _immediate) {
getStateHelper().put(PropertyKeys.immediate, _immediate);
}
/**
* Set whether or not the page parameters should be encoded into the target url.
* @return Returns the value of the attribute, or , false, if it hasn't been set by the JSF file.
*/
public boolean isIncludeViewParams() {
return (boolean) (Boolean) getStateHelper().eval(PropertyKeys.includeViewParams, false);
}
/**
* Set whether or not the page parameters should be encoded into the target url.
* Usually this method is called internally by the JSF engine.
*/
public void setIncludeViewParams(boolean _includeViewParams) {
getStateHelper().put(PropertyKeys.includeViewParams, _includeViewParams);
}
/**
* Alternative spelling to col-lg. Integer value to specify how many columns to span on large screens (≥1200 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getLargeScreen() {
return (String) getStateHelper().eval(PropertyKeys.largeScreen, "-1");
}
/**
* Alternative spelling to col-lg. Integer value to specify how many columns to span on large screens (≥1200 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setLargeScreen(String _largeScreen) {
getStateHelper().put(PropertyKeys.largeScreen, _largeScreen);
}
/**
* Make the link look like a button. Can be primary, block, info, success, warning, important, danger, and default. If not specified, a standard HTML hyperlink is rendered.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getLook() {
return (String) getStateHelper().eval(PropertyKeys.look);
}
/**
* Make the link look like a button. Can be primary, block, info, success, warning, important, danger, and default. If not specified, a standard HTML hyperlink is rendered.
* Usually this method is called internally by the JSF engine.
*/
public void setLook(String _look) {
getStateHelper().put(PropertyKeys.look, _look);
}
/**
* Alternative spelling to col-md. Integer value to specify how many columns to span on medium screens (≥992 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getMediumScreen() {
return (String) getStateHelper().eval(PropertyKeys.mediumScreen, "-1");
}
/**
* Alternative spelling to col-md. Integer value to specify how many columns to span on medium screens (≥992 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setMediumScreen(String _mediumScreen) {
getStateHelper().put(PropertyKeys.mediumScreen, _mediumScreen);
}
/**
* Integer value to specify how many columns to offset.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOffset() {
return (String) getStateHelper().eval(PropertyKeys.offset);
}
/**
* Integer value to specify how many columns to offset.
* Usually this method is called internally by the JSF engine.
*/
public void setOffset(String _offset) {
getStateHelper().put(PropertyKeys.offset, _offset);
}
/**
* Integer value to specify how many columns to offset.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOffsetLg() {
return (String) getStateHelper().eval(PropertyKeys.offsetLg);
}
/**
* Integer value to specify how many columns to offset.
* Usually this method is called internally by the JSF engine.
*/
public void setOffsetLg(String _offsetLg) {
getStateHelper().put(PropertyKeys.offsetLg, _offsetLg);
}
/**
* Integer value to specify how many columns to offset.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOffsetMd() {
return (String) getStateHelper().eval(PropertyKeys.offsetMd);
}
/**
* Integer value to specify how many columns to offset.
* Usually this method is called internally by the JSF engine.
*/
public void setOffsetMd(String _offsetMd) {
getStateHelper().put(PropertyKeys.offsetMd, _offsetMd);
}
/**
* Integer value to specify how many columns to offset.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOffsetSm() {
return (String) getStateHelper().eval(PropertyKeys.offsetSm);
}
/**
* Integer value to specify how many columns to offset.
* Usually this method is called internally by the JSF engine.
*/
public void setOffsetSm(String _offsetSm) {
getStateHelper().put(PropertyKeys.offsetSm, _offsetSm);
}
/**
* Integer value to specify how many columns to offset.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOffsetXs() {
return (String) getStateHelper().eval(PropertyKeys.offsetXs);
}
/**
* Integer value to specify how many columns to offset.
* Usually this method is called internally by the JSF engine.
*/
public void setOffsetXs(String _offsetXs) {
getStateHelper().put(PropertyKeys.offsetXs, _offsetXs);
}
/**
* Client side callback to execute when input element loses focus.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnblur() {
return (String) getStateHelper().eval(PropertyKeys.onblur);
}
/**
* Client side callback to execute when input element loses focus.
* Usually this method is called internally by the JSF engine.
*/
public void setOnblur(String _onblur) {
getStateHelper().put(PropertyKeys.onblur, _onblur);
}
/**
* Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnchange() {
return (String) getStateHelper().eval(PropertyKeys.onchange);
}
/**
* Client side callback to execute when input element loses focus and its value has been modified since gaining focus.
* Usually this method is called internally by the JSF engine.
*/
public void setOnchange(String _onchange) {
getStateHelper().put(PropertyKeys.onchange, _onchange);
}
/**
* The onclick attribute.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnclick() {
return (String) getStateHelper().eval(PropertyKeys.onclick);
}
/**
* The onclick attribute.
* Usually this method is called internally by the JSF engine.
*/
public void setOnclick(String _onclick) {
getStateHelper().put(PropertyKeys.onclick, _onclick);
}
/**
* JavaScript to be executed when ajax completes.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOncomplete() {
return (String) getStateHelper().eval(PropertyKeys.oncomplete);
}
/**
* JavaScript to be executed when ajax completes.
* Usually this method is called internally by the JSF engine.
*/
public void setOncomplete(String _oncomplete) {
getStateHelper().put(PropertyKeys.oncomplete, _oncomplete);
}
/**
* Client side callback to execute when input element is double clicked.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOndblclick() {
return (String) getStateHelper().eval(PropertyKeys.ondblclick);
}
/**
* Client side callback to execute when input element is double clicked.
* Usually this method is called internally by the JSF engine.
*/
public void setOndblclick(String _ondblclick) {
getStateHelper().put(PropertyKeys.ondblclick, _ondblclick);
}
/**
* JavaScript to be executed when ajax results on an error (including both network errors and Java exceptions).
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnerror() {
return (String) getStateHelper().eval(PropertyKeys.onerror);
}
/**
* JavaScript to be executed when ajax results on an error (including both network errors and Java exceptions).
* Usually this method is called internally by the JSF engine.
*/
public void setOnerror(String _onerror) {
getStateHelper().put(PropertyKeys.onerror, _onerror);
}
/**
* Client side callback to execute when input element receives focus.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnfocus() {
return (String) getStateHelper().eval(PropertyKeys.onfocus);
}
/**
* Client side callback to execute when input element receives focus.
* Usually this method is called internally by the JSF engine.
*/
public void setOnfocus(String _onfocus) {
getStateHelper().put(PropertyKeys.onfocus, _onfocus);
}
/**
* Client side callback to execute when a key is pressed down over input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnkeydown() {
return (String) getStateHelper().eval(PropertyKeys.onkeydown);
}
/**
* Client side callback to execute when a key is pressed down over input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnkeydown(String _onkeydown) {
getStateHelper().put(PropertyKeys.onkeydown, _onkeydown);
}
/**
* Client side callback to execute when a key is pressed and released over input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnkeypress() {
return (String) getStateHelper().eval(PropertyKeys.onkeypress);
}
/**
* Client side callback to execute when a key is pressed and released over input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnkeypress(String _onkeypress) {
getStateHelper().put(PropertyKeys.onkeypress, _onkeypress);
}
/**
* Client side callback to execute when a key is released over input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnkeyup() {
return (String) getStateHelper().eval(PropertyKeys.onkeyup);
}
/**
* Client side callback to execute when a key is released over input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnkeyup(String _onkeyup) {
getStateHelper().put(PropertyKeys.onkeyup, _onkeyup);
}
/**
* Client side callback to execute when a pointer input element is pressed down over input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnmousedown() {
return (String) getStateHelper().eval(PropertyKeys.onmousedown);
}
/**
* Client side callback to execute when a pointer input element is pressed down over input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnmousedown(String _onmousedown) {
getStateHelper().put(PropertyKeys.onmousedown, _onmousedown);
}
/**
* Client side callback to execute when a pointer input element is moved within input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnmousemove() {
return (String) getStateHelper().eval(PropertyKeys.onmousemove);
}
/**
* Client side callback to execute when a pointer input element is moved within input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnmousemove(String _onmousemove) {
getStateHelper().put(PropertyKeys.onmousemove, _onmousemove);
}
/**
* Client side callback to execute when a pointer input element is moved away from input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnmouseout() {
return (String) getStateHelper().eval(PropertyKeys.onmouseout);
}
/**
* Client side callback to execute when a pointer input element is moved away from input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnmouseout(String _onmouseout) {
getStateHelper().put(PropertyKeys.onmouseout, _onmouseout);
}
/**
* Client side callback to execute when a pointer input element is moved onto input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnmouseover() {
return (String) getStateHelper().eval(PropertyKeys.onmouseover);
}
/**
* Client side callback to execute when a pointer input element is moved onto input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnmouseover(String _onmouseover) {
getStateHelper().put(PropertyKeys.onmouseover, _onmouseover);
}
/**
* Client side callback to execute when a pointer input element is released over input element.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnmouseup() {
return (String) getStateHelper().eval(PropertyKeys.onmouseup);
}
/**
* Client side callback to execute when a pointer input element is released over input element.
* Usually this method is called internally by the JSF engine.
*/
public void setOnmouseup(String _onmouseup) {
getStateHelper().put(PropertyKeys.onmouseup, _onmouseup);
}
/**
* Client side callback to execute when text within input element is selected by user.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnselect() {
return (String) getStateHelper().eval(PropertyKeys.onselect);
}
/**
* Client side callback to execute when text within input element is selected by user.
* Usually this method is called internally by the JSF engine.
*/
public void setOnselect(String _onselect) {
getStateHelper().put(PropertyKeys.onselect, _onselect);
}
/**
* JavaScript to be executed when ajax completes with success (i.e. there's neither a network error nor a Java exception).
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOnsuccess() {
return (String) getStateHelper().eval(PropertyKeys.onsuccess);
}
/**
* JavaScript to be executed when ajax completes with success (i.e. there's neither a network error nor a Java exception).
* Usually this method is called internally by the JSF engine.
*/
public void setOnsuccess(String _onsuccess) {
getStateHelper().put(PropertyKeys.onsuccess, _onsuccess);
}
/**
* The outcome to navigate to.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getOutcome() {
return (String) getStateHelper().eval(PropertyKeys.outcome);
}
/**
* The outcome to navigate to.
* Usually this method is called internally by the JSF engine.
*/
public void setOutcome(String _outcome) {
getStateHelper().put(PropertyKeys.outcome, _outcome);
}
/**
* Comma or space separated list of ids or search expressions denoting which values are to be sent to the server.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getProcess() {
return (String) getStateHelper().eval(PropertyKeys.process);
}
/**
* Comma or space separated list of ids or search expressions denoting which values are to be sent to the server.
* Usually this method is called internally by the JSF engine.
*/
public void setProcess(String _process) {
getStateHelper().put(PropertyKeys.process, _process);
}
/**
* Alternative spelling to col-sm. Integer value to specify how many columns to span on small screens (≥768p pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getSmallScreen() {
return (String) getStateHelper().eval(PropertyKeys.smallScreen, "-1");
}
/**
* Alternative spelling to col-sm. Integer value to specify how many columns to span on small screens (≥768p pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setSmallScreen(String _smallScreen) {
getStateHelper().put(PropertyKeys.smallScreen, _smallScreen);
}
/**
* Integer value to specify how many columns to span on medium screens (≥992 pixels). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getSpan() {
return (String) getStateHelper().eval(PropertyKeys.span);
}
/**
* Integer value to specify how many columns to span on medium screens (≥992 pixels). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setSpan(String _span) {
getStateHelper().put(PropertyKeys.span, _span);
}
/**
* Inline style
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getStyle() {
return (String) getStateHelper().eval(PropertyKeys.style);
}
/**
* Inline style
* Usually this method is called internally by the JSF engine.
*/
public void setStyle(String _style) {
getStateHelper().put(PropertyKeys.style, _style);
}
/**
* CSS style class
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getStyleClass() {
return (String) getStateHelper().eval(PropertyKeys.styleClass);
}
/**
* CSS style class
* Usually this method is called internally by the JSF engine.
*/
public void setStyleClass(String _styleClass) {
getStateHelper().put(PropertyKeys.styleClass, _styleClass);
}
/**
* Position of this element in the tabbing order for the current document. This value must be an integer between -1 and 32767. By default, Bootstrap uses 0, which means the tab order is relative to the position of the element in the document.
* @return Returns the value of the attribute, or "0", if it hasn't been set by the JSF file.
*/
public String getTabindex() {
return (String) getStateHelper().eval(PropertyKeys.tabindex, "0");
}
/**
* Position of this element in the tabbing order for the current document. This value must be an integer between -1 and 32767. By default, Bootstrap uses 0, which means the tab order is relative to the position of the element in the document.
* Usually this method is called internally by the JSF engine.
*/
public void setTabindex(String _tabindex) {
getStateHelper().put(PropertyKeys.tabindex, _tabindex);
}
/**
* Optional target of the HTML anchor tag that's rendered. E.g. # opens the link in a new tab. This attribute is only evaluated if you provide an href.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getTarget() {
return (String) getStateHelper().eval(PropertyKeys.target);
}
/**
* Optional target of the HTML anchor tag that's rendered. E.g. # opens the link in a new tab. This attribute is only evaluated if you provide an href.
* Usually this method is called internally by the JSF engine.
*/
public void setTarget(String _target) {
getStateHelper().put(PropertyKeys.target, _target);
}
/**
* Alternative spelling to col-xs. Integer value to specify how many columns to span on tiny screens (≤ 767 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* @return Returns the value of the attribute, or "-1", if it hasn't been set by the JSF file.
*/
public String getTinyScreen() {
return (String) getStateHelper().eval(PropertyKeys.tinyScreen, "-1");
}
/**
* Alternative spelling to col-xs. Integer value to specify how many columns to span on tiny screens (≤ 767 pixels wide). The number may optionally be followed by "column" or "columns". Alternative legal values: half, one-third, two-thirds, one-fourth, three-fourths.
* Usually this method is called internally by the JSF engine.
*/
public void setTinyScreen(String _tinyScreen) {
getStateHelper().put(PropertyKeys.tinyScreen, _tinyScreen);
}
/**
* The text of the tooltip.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getTooltip() {
return (String) getStateHelper().eval(PropertyKeys.tooltip);
}
/**
* The text of the tooltip.
* Usually this method is called internally by the JSF engine.
*/
public void setTooltip(String _tooltip) {
getStateHelper().put(PropertyKeys.tooltip, _tooltip);
}
/**
* Where is the tooltip div generated? That's primarily a technical value that can be used to fix rendering errors in special cases. Also see data-container in the documentation of Bootstrap. The default value is body.
* @return Returns the value of the attribute, or "body", if it hasn't been set by the JSF file.
*/
public String getTooltipContainer() {
return (String) getStateHelper().eval(PropertyKeys.tooltipContainer, "body");
}
/**
* Where is the tooltip div generated? That's primarily a technical value that can be used to fix rendering errors in special cases. Also see data-container in the documentation of Bootstrap. The default value is body.
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipContainer(String _tooltipContainer) {
getStateHelper().put(PropertyKeys.tooltipContainer, _tooltipContainer);
}
/**
* The tooltip is shown and hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* @return Returns the value of the attribute, or 0, if it hasn't been set by the JSF file.
*/
public int getTooltipDelay() {
return (int) (Integer) getStateHelper().eval(PropertyKeys.tooltipDelay, 0);
}
/**
* The tooltip is shown and hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipDelay(int _tooltipDelay) {
getStateHelper().put(PropertyKeys.tooltipDelay, _tooltipDelay);
}
/**
* The tooltip is hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* @return Returns the value of the attribute, or 0, if it hasn't been set by the JSF file.
*/
public int getTooltipDelayHide() {
return (int) (Integer) getStateHelper().eval(PropertyKeys.tooltipDelayHide, 0);
}
/**
* The tooltip is hidden with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipDelayHide(int _tooltipDelayHide) {
getStateHelper().put(PropertyKeys.tooltipDelayHide, _tooltipDelayHide);
}
/**
* The tooltip is shown with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* @return Returns the value of the attribute, or 0, if it hasn't been set by the JSF file.
*/
public int getTooltipDelayShow() {
return (int) (Integer) getStateHelper().eval(PropertyKeys.tooltipDelayShow, 0);
}
/**
* The tooltip is shown with a delay. This value is the delay in milliseconds. Defaults to 0 (no delay).
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipDelayShow(int _tooltipDelayShow) {
getStateHelper().put(PropertyKeys.tooltipDelayShow, _tooltipDelayShow);
}
/**
* Where is the tooltip to be displayed? Possible values: "top", "bottom", "right", "left", "auto", "auto top", "auto bottom", "auto right" and "auto left". Default to "bottom".
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getTooltipPosition() {
return (String) getStateHelper().eval(PropertyKeys.tooltipPosition);
}
/**
* Where is the tooltip to be displayed? Possible values: "top", "bottom", "right", "left", "auto", "auto top", "auto bottom", "auto right" and "auto left". Default to "bottom".
* Usually this method is called internally by the JSF engine.
*/
public void setTooltipPosition(String _tooltipPosition) {
getStateHelper().put(PropertyKeys.tooltipPosition, _tooltipPosition);
}
/**
* Component(s) to be updated with ajax.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getUpdate() {
return (String) getStateHelper().eval(PropertyKeys.update);
}
/**
* Component(s) to be updated with ajax.
* Usually this method is called internally by the JSF engine.
*/
public void setUpdate(String _update) {
getStateHelper().put(PropertyKeys.update, _update);
}
/**
* This column is shown on a certain screen size and above. Legal values: lg, md, sm, xs.
* @return Returns the value of the attribute, or null, if it hasn't been set by the JSF file.
*/
public String getVisible() {
return (String) getStateHelper().eval(PropertyKeys.visible);
}
/**
* This column is shown on a certain screen size and above. Legal values: lg, md, sm, xs.
* Usually this method is called internally by the JSF engine.
*/
public void setVisible(String _visible) {
getStateHelper().put(PropertyKeys.visible, _visible);
}
}