Package com.jbstrap.ui.components.wizard

Class Wizard.WizardFooter

java.lang.Object

com.jbstrap.core.messagebus.MessageBus

com.jbstrap.ui.Component<Wizard.WizardFooter>

com.jbstrap.ui.components.wizard.Wizard.WizardFooter

Enclosing class:

Wizard

public class Wizard.WizardFooter
extends Component<Wizard.WizardFooter>

Footer for the wizard component.

The footer contains navigation buttons such as previous step, next step and finish.

Since:

4.0

Author:

JBStrap

Field Summary

Fields

Modifier and Type	Field	Description
final Button	backBtn
final Button	finishBtn
final Button	nextBtn

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
WizardFooter(String id, Wizard parent)

Method Summary

Modifier and Type	Method	Description
Button	getBackBtn()	Gets the “Previous” button in the footer.
Button	getFinishBtn()	Gets the footer’s “Finish” button.
Button	getNextBtn()	Gets the “Next” button in the footer.
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

Field Details

backBtn

public final Button backBtn

nextBtn

public final Button nextBtn

finishBtn

public final Button finishBtn

Constructor Details

WizardFooter

public WizardFooter(String id,
 Wizard parent)

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.)

parent - The wizard component instance associated with the footer

Throws:

NullPointerException - Thrown if the specified wizard component is null

Method Details

getNextBtn

public Button getNextBtn()

Gets the “Next” button in the footer.

Returns:

An instance of the footer’s “Next” button

getBackBtn

public Button getBackBtn()

Gets the “Previous” button in the footer.

Returns:

An instance of the footer’s “Previous” button

getFinishBtn

public Button getFinishBtn()

Gets the footer’s “Finish” button.

Returns:

An instance of the footer’s “Finish” button

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<Wizard.WizardFooter>

Returns:

If the componentwas drawn, true, otherwise false