org.universAAL.middleware.ui.rdf
Class Input

java.lang.Object
  org.universAAL.middleware.rdf.Resource
      org.universAAL.middleware.rdf.FinalizedResource
          org.universAAL.middleware.ui.rdf.FormElement
              org.universAAL.middleware.ui.rdf.FormControl
                  org.universAAL.middleware.ui.rdf.Input

Direct Known Subclasses:

InputField, Range, Select, TextArea

public abstract class Input
extends FormControl

The abstract class for all types of form controls that serve as a placeholder for possible user input.

Author:

mtazari, Carsten Stockloew

Field Summary

static String	MY_URI
static String	PROP_INPUT_ALERT A mandatory (in the sense of "best practice") property for defining a message to be communicated with human users if the provided input by them is erroneous.
static String	PROP_IS_MANDATORY A property that is set automatically by the dialog package as soon as an input control is added to a Submit control as mandatory input.

Fields inherited from class org.universAAL.middleware.ui.rdf.FormControl

PROP_CONTROL_LABEL, PROP_HELP, PROP_HINT, PROP_PARENT_CONTROL, PROP_REFERENCED_PPATH, PROP_VALUE_RESTRICTION

Fields inherited from class org.universAAL.middleware.ui.rdf.FormElement

PROP_APPEARANCE

Fields inherited from class org.universAAL.middleware.rdf.Resource

ANON_URI_PREFIX, blockAddingTypes, isXMLLiteral, ns_delim_index, PROP_RDF_FIRST, PROP_RDF_REST, PROP_RDF_TYPE, PROP_RDFS_COMMENT, PROP_RDFS_LABEL, PROP_SERIALIZATION_FULL, PROP_SERIALIZATION_OPTIONAL, PROP_SERIALIZATION_REDUCED, PROP_SERIALIZATION_UNDEFINED, PROP_uAAL_INVOLVED_HUMAN_USER, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uAAL_NAMESPACE_PREFIX, uAAL_SERVICE_NAMESPACE, uAAL_VOCABULARY_NAMESPACE, uri

Constructor Summary

protected	Input()
protected	Input(String typeURI, Group parent, Label label, PropertyPath ref, MergedRestriction valueRestriction, Object initialValue)

Method Summary

String	getAlertString()
boolean	isMandatory()
void	setAlertString(String value)
boolean	setProperty(String propURI, Object value) For usage by de-serializers.
boolean	storeUserInput(Object value) Tries to store the given value as user input and returns true if it passes all the known restrictions, false otherwise.

Methods inherited from class org.universAAL.middleware.ui.rdf.FormControl

getAncestorRepeat, getFormObject, getHelpString, getHintString, getLabel, getMaxLength, getParentGroup, getParentRepeat, getReferencedPPath, getRestrictions, getSuperGroups, getTypeURI, getValue, hasFocus, hasValue, isOfBooleanType, isOfPrimitiveType, isRepeatable, setHelpString, setHintString, toString

Methods inherited from class org.universAAL.middleware.ui.rdf.FormElement

addAppearanceRecommendation, getAppearanceRecommendations

Methods inherited from class org.universAAL.middleware.rdf.FinalizedResource

addType, getLocalName, getNamespace, getProperty, getPropertyURIs, getType, getTypes, getURI, hasQualifiedName, isAnon, numberOfProperties

Methods inherited from class org.universAAL.middleware.rdf.Resource

addMultiLangProp, asList, asList, asRDFList, changeProperty, copy, deepCopy, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getPropSerializationType, getResource, getResourceComment, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, isWellFormed, literal, representsQualifiedURI, serializesAsXMLLiteral, setPropertyPath, setPropertyPath, setPropertyPathFromOffset, setResourceComment, setResourceLabel, toStringRecursive, toStringRecursive, unliteral

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MY_URI

public static final String MY_URI

See Also:

Constant Field Values

PROP_INPUT_ALERT

public static final String PROP_INPUT_ALERT

A mandatory (in the sense of "best practice") property for defining a message to be communicated with human users if the provided input by them is erroneous.

See Also:

Constant Field Values

PROP_IS_MANDATORY

public static final String PROP_IS_MANDATORY

A property that is set automatically by the dialog package as soon as an input control is added to a Submit control as mandatory input. By default, input controls are optional.

See Also:

Constant Field Values

Constructor Detail

Input

protected Input()

Input

protected Input(String typeURI,
                Group parent,
                Label label,
                PropertyPath ref,
                MergedRestriction valueRestriction,
                Object initialValue)

Method Detail

getAlertString

public String getAlertString()

See Also:

PROP_INPUT_ALERT

isMandatory

public boolean isMandatory()

See Also:

PROP_IS_MANDATORY

setAlertString

public void setAlertString(String value)

See Also:

PROP_INPUT_ALERT

setProperty

public boolean setProperty(String propURI,
                           Object value)

Description copied from class: FormControl

For usage by de-serializers.

Overrides:

setProperty in class FormControl

Returns:

true if the property changed as a result of the call

See Also:

FormControl.setProperty(String, Object)

storeUserInput

public boolean storeUserInput(Object value)

Tries to store the given value as user input and returns true if it passes all the known restrictions, false otherwise.