Package com.jbstrap.ui.components.form

Class FormColumn

java.lang.Object

com.jbstrap.core.messagebus.MessageBus

com.jbstrap.ui.Component<FormColumn>

com.jbstrap.ui.components.form.FormColumn

public class FormColumn
extends Component<FormColumn>

Form column component

The component cannot be used on its own, it is used by the Form component and the form component builder classes. The component is responsible for displaying columns on the form, in which the individual form elements can be grouped. Does not have a visual representation on its own.

Since:

4.0

Author:

JBStrap

Field Summary

Fields inherited from class com.jbstrap.ui.Component

animation, attributes, backgroundColor, borderColor, color, defaultHotKeyHandler, handlers, hotKeys, styleClasses, textAlign, toolTip, toolTipPosition

Constructor Summary

Constructors

Constructor	Description
FormColumn(String id, int index)	Creates a form column component

Method Summary

Modifier and Type	Method	Description
final int	getIndex()	Gets the column's index
boolean	writeHTML(StringWriter writer)	Creates the component's HTML equivalent

Methods inherited from class com.jbstrap.ui.Component

_hide, _setAttribute, addAllowedRole, addComponent, addComponent, addComponents, addDeniedRole, addHandler, addStyle, addStyleClass, addStyleClasses, afterDraw, clearfix, closeTag, combinateAccess, containsStyle, containsStyleClass, draw, drawSubComponents, error, flattendComponentTree, getAccess, getAccessMode, getAllowedRoles, getAttribute, getAttributes, getBackgroundColor, getBorderColor, getClient, getComponentById, getComponents, getComponents, getComponentsByClass, getData, getDeniedRoles, getHandlers, getId, getLanguageCode, getName, getParent, getParent, getRegisteredEvents, getStyle, getStyleClasses, getTextAlign, getTextColor, getToolTip, getToolTipPosition, getTypeName, getUI, init, insertComponentAfter, insertComponentBefore, isAccess, isDrawn, isEnabled, isEventBubbling, isVisible, onHide, onHotKeyEventHandler, onShow, openTag, redraw, removeAllComponents, removeAllowedRole, removeAllStyleClasses, removeAttribute, removeComponent, removeComponent, removeComponents, removeDeniedRole, removeHandler, removeStyle, removeStyle, removeStyleClass, removeStyleClasses, replaceComponent, replaceStyleClass, runAfterDraw, runJavaScript, runJavaScript, runJavaScript, runOnHide, runOnShow, say, setAttribute, setBackgroundColor, setBorder, setBorderColor, setData, setDisplayType, setEnabled, setEventBubbling, setFlex, setFloating, setHeight100, setHeight25, setHeight50, setHeight75, setHeightAuto, setLanguage, setMargin, setName, setOverflow, setPadding, setParent, setScrollable, setSelectionType, setShadow, setStyle, setTextAlign, setTextColor, setToolTip, setToolTipPosition, setVisible, setWidth100, setWidth25, setWidth50, setWidth75, setWidthAuto, showNotification, showNotification, showProcessIndicator, toggleStyleClass

Methods inherited from class com.jbstrap.core.messagebus.MessageBus

closeMessageBus, messageBusOpened, openMessageBus, renewSubscription, sendMessageToMessageBus, subscribeMessageBus, unsubscribeAllListeners, unsubscribeMessageBus

Methods inherited from class java.lang.Object

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

Constructor Details

FormColumn

public FormColumn(String id,
 int index)

Creates a form column component

Parameters:

id - The component ID. The ID specified here will appear in the HTML tag as an ID attribute. If there are multiple components displayed, that have the same ID, the ID numbers will be numbered, in the order they are displayed. (For example, if the ID is 'COMPONENT' then it will be numbered like this: COMPONENT, COMPONENT_1, COMPONENT_2 etc.)

index - The column's index value. Level 0 is the first column to be displayed.

Method Details

getIndex

public final int getIndex()

Gets the column's index

Returns:

The column index

writeHTML

public boolean writeHTML(StringWriter writer)

Description copied from class: Component

Creates the component's HTML equivalent

This method doesn't need to be used during application development. This method is used when developing a custom component. When creating a custom component, this method needs to be implemented. In the parameter (StringWriter class) the component's HTML equivalent must be specified, and the method has to return with a Boolean value. This boolean value determines if the component was drawn. If the user doesn't have access right to the component, or if the component couldn't be drawn, it should return with false. Otherwise, it must return with true.

Specified by:

writeHTML in class Component<FormColumn>

Returns:

If the componentwas drawn, true, otherwise false