|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectpivot.wtk.Component
pivot.wtk.Container
pivot.wtk.Form
public class Form
A container that arranges field components in a form layout. Each field has an optional text label associated with it and may be flagged as requiring attention using one of several flag types and an optional flag message (for use during form validation, for example).
TODO Add a label alignment attribute (vertical).
Nested Class Summary | |
---|---|
static class |
Form.Flag
Represents an message alert associated with a form field. |
protected static class |
Form.FormAttributes
Defines form field attributes. |
static class |
Form.Section
Class representing a menu section. |
class |
Form.SectionSequence
Section sequence implementation. |
Nested classes/interfaces inherited from class pivot.wtk.Component |
---|
Component.Attributes, Component.ComponentDictionary, Component.DecoratorSequence, Component.StyleDictionary |
Nested classes/interfaces inherited from interface pivot.collections.Sequence |
---|
Sequence.Search, Sequence.Sort, Sequence.Tree |
Constructor Summary | |
---|---|
Form()
Creates a new form. |
Method Summary | |
---|---|
static Form.Flag |
getFlag(Component component)
|
int |
getFlaggedFieldCount(MessageType messageType)
Returns the number of fields that are flagged with a given flag type. |
ListenerList<FormAttributeListener> |
getFormAttributeListeners()
Returns the form attribute listener list. |
ListenerList<FormListener> |
getFormListeners()
Returns the form listener list. |
static java.lang.String |
getName(Component component)
|
static Form.Section |
getSection(Component component)
|
Form.SectionSequence |
getSections()
Returns the form's field sequence. |
Sequence<Component> |
remove(int index,
int count)
Removes one or more items from the sequence. |
static void |
setFlag(Component component,
Form.Flag flag)
|
static void |
setFlag(Component component,
java.lang.String flag)
|
static void |
setName(Component component,
java.lang.String name)
|
Methods inherited from class pivot.wtk.Container |
---|
add, containsFocus, get, getComponentAt, getContainerListeners, getContainerMouseListeners, getContextKey, getDescendantAt, getFocusTraversalPolicy, getLength, indexOf, insert, invalidate, isAncestor, isFocusable, isValid, iterator, load, load, mouseClick, mouseDown, mouseMove, mouseOut, mouseUp, mouseWheel, move, paint, remove, removeAll, requestFocus, setContextKey, setEnabled, setFocusTraversalPolicy, setParent, setTooltip, setVisible, store, store, update, validate |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Form()
Method Detail |
---|
public Form.SectionSequence getSections()
public int getFlaggedFieldCount(MessageType messageType)
messageType
- The message type to count, or null to return the count of all
flagged fields regardless of message type.public Sequence<Component> remove(int index, int count)
Sequence
remove
in interface Sequence<Component>
remove
in class Container
index
- The starting index to remove.count
- The number of items to remove, beginning with index.
public ListenerList<FormListener> getFormListeners()
public ListenerList<FormAttributeListener> getFormAttributeListeners()
public static Form.Section getSection(Component component)
public static java.lang.String getName(Component component)
public static void setName(Component component, java.lang.String name)
public static Form.Flag getFlag(Component component)
public static void setFlag(Component component, Form.Flag flag)
public static final void setFlag(Component component, java.lang.String flag)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |