com.motivewave.platform.sdk.common.desc

Class DateTimeDescriptor

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor

com.motivewave.platform.sdk.common.desc.DateTimeDescriptor

public class DateTimeDescriptor
extends SettingDescriptor

Describes an input for selecting a date/time. Dates are represented using long values (number of milliseconds since 1970, AKA epoch time)

Constructor Summary

Constructors

Constructor and Description
DateTimeDescriptor(java.lang.String name, java.lang.String label, long defaultValue) Constructor.
DateTimeDescriptor(java.lang.String name, java.lang.String label, long defaultValue, boolean dateOnly) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
javax.swing.JComponent	createInput(Settings settings, boolean readOnly) Creates the component that will accept the user input.
java.lang.Long	getDefaultValue() Gets the default value as a Long (epoch time).
boolean	isDateOnly() Returns true if only date values are accepted (not time).
void	setDateOnly(boolean b) Sets the input to only accept date values (not time).

Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor

getGridWidth, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setEnabled, setGridWidth, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

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

Constructor Detail

DateTimeDescriptor

public DateTimeDescriptor(java.lang.String name,
                  java.lang.String label,
                  long defaultValue)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - (epoch time, number of milliseconds since 1970)

DateTimeDescriptor

public DateTimeDescriptor(java.lang.String name,
                  java.lang.String label,
                  long defaultValue,
                  boolean dateOnly)

Constructor.

Parameters:

name - name of this setting (key)

label - label displayed to the user

defaultValue - (epoch time, number of milliseconds since 1970)

dateOnly - true if only date values (not time) are accepted

Method Detail

getDefaultValue

public java.lang.Long getDefaultValue()

Gets the default value as a Long (epoch time).

Overrides:

getDefaultValue in class SettingDescriptor

Returns:

the default value as a Long (epoch time)

setDateOnly

public void setDateOnly(boolean b)

Sets the input to only accept date values (not time).

Parameters:

b - true if date only input is allowed

isDateOnly

public boolean isDateOnly()

Returns true if only date values are accepted (not time).

Returns:

true if only date values are accepted

createInput

public javax.swing.JComponent createInput(Settings settings,
                                 boolean readOnly)

Description copied from class: SettingDescriptor

Creates the component that will accept the user input. This is called by the study framework.

Specified by:

createInput in class SettingDescriptor

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.