org.universAAL.middleware.ui.rdf
Class SubdialogTrigger

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.Submit
                      org.universAAL.middleware.ui.rdf.SubdialogTrigger

public class SubdialogTrigger
extends Submit

A subclass of Submit that does not finish the current dialog but starts a subdialog, normally used for viewing or editing complex data that was represented in the main dialog in a summarized way or in way not suitable for editing.

Author:

mtazari, Carsten Stockloew

Field Summary

static String	MY_URI
static String	PROP_REPEATABLE_ID_PREFIX If a SubdialogTrigger is used in a column of a Repeat control, each occurrence of it in each row of the table represented by the Repeat control must have another Submit.PROP_SUBMISSION_ID in order to be able to distinguish between them.
static String	VAR_REPEATABLE_ID

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

CONFIRMATION_TYPE_OK_CANCEL, CONFIRMATION_TYPE_YES_NO, mandatoryList, PROP_CONFIRMATION_MESSAGE, PROP_CONFIRMATION_TYPE, PROP_MANDATORY_INPUT, PROP_SUBMISSION_ID

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

SubdialogTrigger()
For exclusive use by de-serializers.

SubdialogTrigger(Group parent, Label label, String id)
For exclusive use by applications.

Method Summary

String	getID() Overrides Submit.getID().
String	getRepeatableIDPrefix()
boolean	needsSelection() Checks if the submission ID of this SubdialogTrigger equals to VAR_REPEATABLE_ID, which means that there must be an ancestor Repeat control with a valid selection index in order to be able to construct the submission ID.
boolean	setProperty(String propURI, Object value) For exclusive use by de-serializers.
void	setRepeatableIDPrefix(String prefix)

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

addMandatoryInput, getConfirmationMessage, getConfirmationType, getDialogID, getMandatoryInputControls, getMaxLength, getMissingInputControl, getMissingInputControls, getRelatedControls, hasMandatoryInput, setConfirmationOkCancel, setConfirmationYesNo

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

getAncestorRepeat, getFormObject, getHelpString, getHintString, getLabel, 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_REPEATABLE_ID_PREFIX

public static final String PROP_REPEATABLE_ID_PREFIX

If a SubdialogTrigger is used in a column of a Repeat control, each occurrence of it in each row of the table represented by the Repeat control must have another Submit.PROP_SUBMISSION_ID in order to be able to distinguish between them. In such cases, applications must set the submission ID equal to VAR_REPEATABLE_ID and specify a prefix as a string to be stored under this property. Consequently, a repeatable SubdialogTrigger that has VAR_REPEATABLE_ID as value associated with Submit.PROP_SUBMISSION_ID will answer to the call of getID() with a string constructed by appending the current selection index obtained from the nearest ancestor Repeat to the prefix stored here. The prefix is needed in order to be able to distinguish between different instances of SubdialogTrigger that appear in different Repeat controls or in different columns of the same Repeat control.

See Also:

Constant Field Values

VAR_REPEATABLE_ID

public static final String VAR_REPEATABLE_ID

See Also:

PROP_REPEATABLE_ID_PREFIX, Constant Field Values

Constructor Detail

SubdialogTrigger

public SubdialogTrigger()

For exclusive use by de-serializers.

SubdialogTrigger

public SubdialogTrigger(Group parent,
                        Label label,
                        String id)

For exclusive use by applications.

Parameters:

parent - The mandatory parent group as the direct container of this input field. See FormControl.PROP_PARENT_CONTROL.

label - The optional Label to be associated with this input field. See FormControl.PROP_CONTROL_LABEL.

id - The mandatory submission ID. See Submit.PROP_SUBMISSION_ID.

Method Detail

getID

public String getID()

Overrides Submit.getID().

Overrides:

getID in class Submit

See Also:

PROP_REPEATABLE_ID_PREFIX

getRepeatableIDPrefix

public String getRepeatableIDPrefix()

See Also:

PROP_REPEATABLE_ID_PREFIX

needsSelection

public boolean needsSelection()

Checks if the submission ID of this SubdialogTrigger equals to VAR_REPEATABLE_ID, which means that there must be an ancestor Repeat control with a valid selection index in order to be able to construct the submission ID.

See Also:

PROP_REPEATABLE_ID_PREFIX

setProperty

public boolean setProperty(String propURI,
                           Object value)

For exclusive use by de-serializers.

Overrides:

setProperty in class Submit

Returns:

true if the property changed as a result of the call

See Also:

Resource.setProperty(String, Object)

setRepeatableIDPrefix

public void setRepeatableIDPrefix(String prefix)

See Also:

PROP_REPEATABLE_ID_PREFIX