|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<ListGridFieldType>
com.smartgwt.client.types.ListGridFieldType
public enum ListGridFieldType
ListGrids format data for viewing and editing based on the type attribute of the field. This table describes how the ListGrid deals with the various built-in types.
Enum Constant Summary | |
---|---|
BINARY
For viewing, the grid renders a 'view' icon (looking glass) followed by a 'download' icon and then the name of the file is displayed in text. |
|
BOOLEAN
For viewing and editing a checkbox is shown with a check mark for the true value and no check mark
for the false value. |
|
DATE
Expected to contain Date type data. |
|
FLOAT
Same as text . |
|
ICON
Shows field.icon in every cell, and also in the header. |
|
IMAGE
For viewing, a thumbnail image is rendered in the field. |
|
IMAGEFILE
Same as binary |
|
INTEGER
Same as text . |
|
LINK
For viewing, the field value is rendered as a clickable html link (using an HTML anchor tag: <A>). |
|
SEQUENCE
Same as text |
|
TEXT
Simple text rendering for view. |
|
TIME
Expected to contain Time data encoded in javascript Date objects.
Times will be formatted using
${isc.DocUtils.linkForRef('attr:ListGridField.displayFormat')} if specified,
otherwise
${isc.DocUtils.linkForRef('attr:ListGrid.timeFormatter')}.If both these attributes are unset, times are formatted using the standard ${isc.DocUtils.linkForRef('classAttr:Time.shortDisplayFormat','short display format')} for times. For editing, by default a TimeItem is used. |
Method Summary | |
---|---|
java.lang.String |
getValue()
|
static ListGridFieldType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static ListGridFieldType[] |
values()
Returns an array containing the constants of this enum type, in the order they're declared. |
Methods inherited from class java.lang.Enum |
---|
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final ListGridFieldType TEXT
length
attribute) is larger than the
value specified by longTextEditorThreshold
, a
text input icon is
shown that, when clicked on (or field is focused in) opens a larger
editor that expands outside the
boundaries of the cell (textarea by default, but
overrideable via longTextEditorType
.
public static final ListGridFieldType BOOLEAN
true
value and no check mark
for the false
value. See
booleanTrueImage
for
customization.
public static final ListGridFieldType INTEGER
text
. Consider setting editorType
to use a SpinnerItem
.
public static final ListGridFieldType FLOAT
text
. Consider setting editorType
to use a SpinnerItem
.
public static final ListGridFieldType DATE
Date
type data. Dates will be formatted using
${isc.DocUtils.linkForRef('attr:ListGridField.displayFormat')} if specified, otherwise
dateFormatter
.
If both these attributes are unset, dates are
formatted using the standard
${isc.DocUtils.linkForRef('classMethod:Date.setShortDisplayFormat','short
display format')} for dates.DateItem
is
used with useTextField
set
to true, providing textual date entry
plus a pop-up date picker. The
displayFormat
and
inputFormat
for the editor will be picked up from
the ListGridField, if specified.
public static final ListGridFieldType TIME
Date
objects.
Times will be formatted using
${isc.DocUtils.linkForRef('attr:ListGridField.displayFormat')} if specified,
otherwise
${isc.DocUtils.linkForRef('attr:ListGrid.timeFormatter')}.TimeItem
is used.
The
displayFormat
for the editor will be picked
up from
the ListGridField, if specified.
public static final ListGridFieldType SEQUENCE
text
public static final ListGridFieldType LINK
linkText
or
linkText
.field.target
, which works indentically
to the target"
attribute on an HTML anchor (<A>) tag.
public static final ListGridFieldType IMAGE
activeAreaHTML
, and
extraStuff
- these are passed to ${isc.DocUtils.linkForRef('method:Canvas.imgHTML')} to generate
the
final URL.
public static final ListGridFieldType ICON
field.icon
in every cell, and also in the header.
Useful for a field that is used as a button, for example, launches a detail
 window or removes a row.
Implement a ListGridField.addRecordClickHandler(com.smartgwt.client.widgets.grid.events.RecordClickHandler)
#010 to define a
behavior for the button.#010 <P>#010 NOTE: for a field that shows different icons depending on the
field value, see valueIcons
.
also defaults to a small field width, accomodating just the icon
 with padding, and to a blank header title,
so that the header shows the icon only. #010 ListGridField.setIconWidth(Integer)
iconWidth} and related properties configure

the size of the icon both in the header and in body cells.#010
cellIcon
instead, leaving field.icon null.
public static final ListGridFieldType BINARY
public static final ListGridFieldType IMAGEFILE
binary
Method Detail |
---|
public static final ListGridFieldType[] values()
for(ListGridFieldType c : ListGridFieldType.values()) System.out.println(c);
public static ListGridFieldType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified namepublic java.lang.String getValue()
getValue
in interface ValueEnum
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |