Module flying.saucer

Package org.xhtmlrenderer.simple.extend.form

Class FormField<T extends JComponent>

java.lang.Object

org.xhtmlrenderer.simple.extend.form.FormField<T>

Direct Known Subclasses:

InputField

public abstract class FormField<T extends JComponent>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected @Nullable Integer	intrinsicHeight
protected @Nullable Integer	intrinsicWidth

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FormField(Element e, XhtmlForm form, LayoutContext context, BlockBox box)

Method Summary

Modifier and Type	Method	Description
protected void	applyComponentStyle(JComponent comp)
protected void	applyOriginalState()
protected <Subtype extends T> Subtype	component()
abstract @Nullable T	create()
protected String	getAttribute(String attributeName)
protected String	getAttribute(String attributeName, String defaultValue)
BlockBox	getBox()
@Nullable T	getComponent()
LayoutContext	getContext()
protected Element	getElement()
protected abstract String[]	getFieldValues()
@Nullable Font	getFont()
Collection<String>	getFormDataStrings()
Dimension	getIntrinsicSize()
protected FormFieldState	getOriginalState()
XhtmlForm	getParentForm()
@Nullable CalculatedStyle	getStyle()
protected UserAgentCallback	getUserAgentCallback()
protected String	getValueAttribute(String defaultValue)
protected boolean	hasAttribute(String attributeName)
boolean	includeInSubmission(JComponent source)	Returns true if the value of the current FormField should be sent along with the current submission.
protected FormFieldState	loadOriginalState()
void	reset()

Methods inherited from class java.lang.Object

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

Field Details

intrinsicWidth

protected @Nullable Integer intrinsicWidth

intrinsicHeight

protected @Nullable Integer intrinsicHeight

Constructor Details

FormField

protected FormField(Element e,
 XhtmlForm form,
 LayoutContext context,
 BlockBox box)

Method Details

getElement

protected Element getElement()

getComponent

public @Nullable T getComponent()

component

protected <Subtype extends T> Subtype component()

getParentForm

public XhtmlForm getParentForm()

getIntrinsicSize

@CheckReturnValue
public Dimension getIntrinsicSize()

reset

public void reset()

getUserAgentCallback

protected UserAgentCallback getUserAgentCallback()

getOriginalState

protected FormFieldState getOriginalState()

getValueAttribute

protected String getValueAttribute(String defaultValue)

hasAttribute

protected boolean hasAttribute(String attributeName)

getAttribute

protected String getAttribute(String attributeName)

getAttribute

protected String getAttribute(String attributeName,
 String defaultValue)

create

public abstract @Nullable T create()

loadOriginalState

protected FormFieldState loadOriginalState()

applyOriginalState

protected void applyOriginalState()

includeInSubmission

public boolean includeInSubmission(JComponent source)

Returns true if the value of the current FormField should be sent along with the current submission. This is used so that only the value of the submit button that is used to trigger the form's submission is sent.

Parameters:

source - The JComponent that caused the submission

Returns:

true if it should

getFormDataStrings

public Collection<String> getFormDataStrings()

getFieldValues

protected abstract String[] getFieldValues()

getBox

public BlockBox getBox()

getContext

public LayoutContext getContext()

getStyle

public @Nullable CalculatedStyle getStyle()

applyComponentStyle

protected void applyComponentStyle(JComponent comp)

getFont

@CheckReturnValue
public @Nullable Font getFont()