* A form control's output style is set using the {@link FormControl#setOutputStyle(FormControlOutputStyle)} method. */ public enum FormControlOutputStyle { /** * Normal display of the output element. *
* This is the default display style. */ NORMAL, /** * Remove the output element from the {@linkplain OutputDocument output document} completely. */ REMOVE, /** * The {@linkplain #NORMAL normal} output element is replaced with a simple representation * of the {@linkplain FormControl form control's} submission value(s). *
* The implementation of this functionality is highly subjective, but provides a more aesthetic way of displaying a read-only version * of a form without having to resort to using {@linkplain FormControl#isDisabled() disabled} controls. *
* The representation is dependent on the {@linkplain FormControlType form control type}, and can be configured using the * static properties of the {@link ConfigDisplayValue ConfigDisplayValue} nested class. *
* Unless specified otherwise below, the {@linkplain #NORMAL normal} output element is
* replaced with a display value element having the {@linkplain Element#getName() name}
* specified in the static {@link ConfigDisplayValue#ElementName ConfigDisplayValue.ElementName} property
* (div by default).
* The attributes specified in the static {@link ConfigDisplayValue#AttributeNames ConfigDisplayValue.AttributeNames} list
* (id, class and style by default) are copied from
* the {@linkplain #NORMAL normal} output element into the
* display value element.
*
* Details of the content of the display value element or other representation of the * control value are as follows: *
*
value attribute.
* TEXTAREA element
* re-encoded {@linkplain CharacterReference#encodeWithWhiteSpaceFormatting(CharSequence) with white space formatting}.
* checked attribute.
* If the relevant static property has a value of null (the default), the
* output element is simply a {@linkplain FormControl#setDisabled(boolean) disabled}
* version of the form control.
* Attempting to determine which labels might apply to which checkbox or radio button, allowing only the
* selected controls to be displayed, would require a very complex and inexact algorithm, so is best left to the developer
* to implement if required.
* , " by default).
* *' by default),
* repeated n times, where n is the number of characters in the control's
* submission value.
*
* If the submission value of the control is null or an empty string,
* the display value element is given the un-encoded content specified in the
* {@link ConfigDisplayValue#EmptyHTML ConfigDisplayValue.EmptyHTML} static property.
*/
DISPLAY_VALUE;
/**
* Returns a string representation of this object useful for debugging purposes.
*
* This is equivalent to {@link #toString()}. * * @return a string representation of this object useful for debugging purposes. */ public String getDebugInfo() { return toString(); } /** * Contains static properties that configure the {@link #DISPLAY_VALUE} form control output style. *
* None of the properties should be assigned a null value.
*
* See the documentation of the {@link #DISPLAY_VALUE} output style for details on how these properties are used. */ public static final class ConfigDisplayValue { /** * Defines the text that is used to separate multiple values in a * display value element. *
* This property is only relevant to {@link FormControlType#SELECT_MULTIPLE SELECT_MULTIPLE} form controls, and is only used * if multiple items in the control are selected. *
* The default value is ", ".
*/
public static volatile String MultipleValueSeparator=", ";
/**
* Defines the {@linkplain Element#getName() name} of
* display value elements.
*
* The default value is "div".
*
* Although all form control {@linkplain FormControl#getElement() elements} are
* {@linkplain HTMLElements#getInlineLevelElementNames() inline-level} elements, the default replacement is the
* {@linkplain HTMLElements#getBlockLevelElementNames() block-level} {@link HTMLElementName#DIV DIV} element, which allows
* richer stylesheet formatting than the most common alternative, the {@link HTMLElementName#SPAN SPAN} element,
* such as the ability to set its width and height.
*
* This has the undesired effect in some cases of displaying the value on a new line, whereas the original form control
* was not on a new line. In practical use however, many form controls are placed inside table cells for better control
* over their positioning. In this case replacing the original inline form control with the block DIV
* element does not alter its position.
*/
public static volatile String ElementName=HTMLElementName.DIV;
/**
* Defines the names of the {@linkplain Attributes attributes} that are copied from the normal form control
* output element to a
* display value element.
*
* The names included in the list by default are "id", "class" and "style".
*
* These attributes are usually all that is needed to identify the elements in style sheets or specify the styles directly. *
* The default list is modifiable.
*/
public static volatile List
* The content is not {@linkplain CharacterReference#encode(CharSequence) encoded} before output.
*
* The default content is "
* The character is repeated n times, where n is the number of characters in the control's
* submission value.
*
* The resulting string is {@linkplain CharacterReference#encode(CharSequence) encoded} before output.
*
* The default password character is '
* If this property is
* The HTML is not {@linkplain CharacterReference#encode(CharSequence) encoded} before output.
*
* The default value is
* If this property is
* The HTML is not {@linkplain CharacterReference#encode(CharSequence) encoded} before output.
*
* The default value is null or an empty string.
* ".
*/
public static volatile String EmptyHTML=" ";
/**
* Defines the character used to represent the value of a {@link FormControlType#PASSWORD PASSWORD} form control
* in a display value element.
* *'.
*/
public static volatile char PasswordChar='*';
/**
* Defines the HTML which replaces the {@linkplain #NORMAL normal} output element
* of a {@link FormControlType#CHECKBOX CHECKBOX} or {@link FormControlType#RADIO RADIO} form control if it contains a
* checked attribute.
* null, the output element is simply a
* {@linkplain FormControl#setDisabled(boolean) disabled} version of the form control.
* null.
*/
public static volatile String CheckedHTML=null;
/**
* Defines the HTML which replaces the {@linkplain #NORMAL normal} output element
* of a {@link FormControlType#CHECKBOX CHECKBOX} or {@link FormControlType#RADIO RADIO} form control if it does not contain a
* checked attribute.
* null, the output element is simply a
* {@linkplain FormControl#setDisabled(boolean) disabled} version of the form control.
* null.
*/
public static volatile String UncheckedHTML=null;
private ConfigDisplayValue() {}
}
}