org.docx4j.org.xhtmlrenderer.simple.xhtml

Interface FormControl

All Known Implementing Classes:

AbstractControl, ButtonControl, CheckControl, HiddenControl, SelectControl, TextControl

public interface FormControl

Interface describing a form control.

Author:

Vianney le Clément

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormControlListener(FormControlListener listener)
Element	getElement()
XhtmlForm	getForm()
String	getInitialValue()
String[]	getMultipleValues()
String	getName()
String	getValue()
boolean	isEnabled() Is this control enabled?
boolean	isMultiple()
boolean	isSuccessful() Is this control successful?
void	removeFormControlListener(FormControlListener listener)
void	reset() Reset the control to it's initial state
void	setEnabled(boolean enabled) Enable/disable this control
void	setMultipleValues(String[] values) Sets the control's current values (when isMultiple returns true).
void	setSuccessful(boolean successful) Sets this control's successful state.
void	setValue(String value) Sets the control's current value.

Method Detail

getElement

Element getElement()

Returns:

the associated element

getForm

XhtmlForm getForm()

Returns:

the associated form

addFormControlListener

void addFormControlListener(FormControlListener listener)

removeFormControlListener

void removeFormControlListener(FormControlListener listener)

getName

String getName()

Returns:

the name of the control

isEnabled

boolean isEnabled()

Is this control enabled?

Returns:

true if this control is enabled

setEnabled

void setEnabled(boolean enabled)

Enable/disable this control

Parameters:

enabled -

getInitialValue

String getInitialValue()

Returns:

the initial value

isSuccessful

boolean isSuccessful()

Is this control successful?

Returns:

true if this control is successful and its name-value pair should be submitted, false otherwise.

isMultiple

boolean isMultiple()

Returns:

true if this control accepts multiple values, false otherwise

setSuccessful

void setSuccessful(boolean successful)

Sets this control's successful state.

Parameters:

successful -

getValue

String getValue()

Returns:

the control's current value or null if isMultiple returns true

setValue

void setValue(String value)

Sets the control's current value. This has no effect when isMultiple returns true.

Parameters:

value -

getMultipleValues

String[] getMultipleValues()

Returns:

the control's current values or null if isMultiple returns false

setMultipleValues

void setMultipleValues(String[] values)

Sets the control's current values (when isMultiple returns true). This has no effect when isMultiple returns false.

Parameters:

values -

reset

void reset()

Reset the control to it's initial state