public class Form extends Container
Container
handles the menus and title while placing content between them. By default a
forms central content (the content pane) is scrollable.
Form contains Title bar, MenuBar and a ContentPane.
Calling to addComponent on the Form is delegated to the contenPane.addComponent
*************************** * Title * ************************** * * * * * ContentPane * * * * * ************************** * MenuBar * **************************
Modifier and Type | Field and Description |
---|---|
protected boolean |
focusScrolling
Indicates whether lists and containers should scroll only via focus and thus "jump" when
moving to a larger component as was the case in older versions of LWUIT.
|
BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, LEFT, RIGHT, TOP
Constructor and Description |
---|
Form()
Default constructor creates a simple form
|
Form(String title)
Sets the title after invoking the constructor
|
Modifier and Type | Method and Description |
---|---|
protected void |
actionCommand(Command cmd)
Invoked to allow subclasses of form to handle a command from one point
rather than implementing many command instances.
|
void |
addCommand(Command cmd)
Adds a command to the menu bar softkeys.
|
void |
addCommand(Command cmd,
int offset)
Adds a command to the menu bar softkeys or into the menu dialog,
this version of add allows us to place a command in an arbitrary location.
|
void |
addCommandListener(ActionListener l)
A listener that is invoked when a command is clicked allowing multiple commands
to be handled by a single block
|
void |
addComponent(Component cmp)
Adds Component to the Form's Content Pane
|
void |
addComponent(int index,
Component cmp)
Adds Component to the Form's Content Pane
|
void |
addComponent(int index,
Object constraints,
Component cmp)
Adds a Component to the Container
|
void |
addComponent(Object constraints,
Component cmp)
Adds a Component to the Container
|
void |
addGameKeyListener(int keyCode,
ActionListener listener)
Add a game key listener to the given gamekey for a callback when the
key is released
|
void |
addKeyListener(int keyCode,
ActionListener listener)
Add a key listener to the given keycode for a callback when the key is released
|
void |
addPointerDraggedListener(ActionListener l)
Adds a listener to the pointer event
|
void |
addPointerPressedListener(ActionListener l)
Adds a listener to the pointer event
|
void |
addPointerReleasedListener(ActionListener l)
Adds a listener to the pointer event
|
protected int |
calculateTouchCommandGridColumns(Container grid)
Calculates the amount of columns to give to the touch commands within the grid
|
protected Component |
createCommandComponent(Vector commands)
Creates the component containing the commands within the given vector
used for showing the menu dialog, this method calls the createCommandList
method by default however it allows more elaborate menu creation.
|
protected List |
createCommandList(Vector commands)
Creates the list component containing the commands within the given vector
used for showing the menu dialog
|
protected Command |
createMenuCancelCommand()
Factory method that returns the Form Menu cancel Command.
|
protected Command |
createMenuSelectCommand()
Factory method that returns the Form Menu select Command.
|
protected Command |
createSelectCommand()
Factory method that returns the Form select Command.
|
protected Button |
createTouchCommandButton(Command c)
Creates a touch command for use as a touch menu item
|
void |
deregisterAnimated(Animation cmp)
Indicate that cmp would no longer like to receive animation events
|
void |
dispatchCommand(Command cmd,
ActionEvent ev)
Dispatches a command via the standard form mechanism of firing a command event
|
Command |
getBackCommand()
Indicates the command that is defined as the back command out of this form.
|
Command |
getClearCommand()
Indicates the command that is defined as the clear command in this form.
|
Command |
getCommand(int index)
Returns the command occupying the given index
|
int |
getCommandCount()
A helper method to check the amount of commands within the form menu
|
Form |
getComponentForm()
Returns the Component Form or null if this Component
is not added yet to a form
|
int |
getComponentIndex(Component cmp)
Returns the Component index in the Container
|
Container |
getContentPane()
This method returns the Content pane instance
|
Command |
getDefaultCommand()
Default command is invoked when a user presses fire, this functionality works
well in some situations but might collide with elements such as navigation
and combo boxes.
|
Component |
getFocused()
Returns the current focus component for this form
|
Painter |
getGlassPane()
Allows a developer that doesn't derive from the form to draw on top of the
form regardless of underlying changes or animations.
|
Layout |
getLayout()
Returns the layout manager responsible for arranging this container
|
Style |
getMenuStyle()
Returns the style of the menu
|
int |
getScrollAnimationSpeed()
Scroll animation speed in milliseconds allowing a developer to slow down or accelerate
the smooth animation mode
|
Button |
getSoftButton(int offset)
Returns the button representing the softbutton, this allows modifying softbutton
attributes and behavior programmatically rather than by using the command API.
|
int |
getSoftButtonCount()
Returns the number of buttons on the menu bar for use with getSoftButton()
|
Style |
getSoftButtonStyle()
Retrieves the style of the menu bar programmatically
|
int |
getTintColor()
Default color for the screen tint when a dialog or a menu is shown
|
String |
getTitle()
Returns the Form title text
|
Label |
getTitleComponent()
Allows modifying the title attributes beyond style (e.g.
|
Style |
getTitleStyle()
Returns the style of the title
|
Transition |
getTransitionInAnimator()
This property allows us to define a an animation that will draw the transition for
entering this form.
|
Transition |
getTransitionOutAnimator()
This property allows us to define a an animation that will draw the transition for
exiting this form.
|
boolean |
hasMedia()
Used by the implementation to prevent flickering when flushing the double buffer
|
protected void |
hideNotify()
This method is only invoked when the underlying canvas for the form is hidden
this method isn't called for form based events and is generally usable for
suspend/resume based behavior
|
boolean |
isCyclicFocus()
Indicates whether focus should cycle within the form
|
boolean |
isFocusScrolling()
Indicates whether lists and containers should scroll only via focus and thus "jump" when
moving to a larger component as was the case in older versions of LWUIT.
|
protected boolean |
isReverseSoftButtons()
Allows an individual form to reverse the layout direction of the softbuttons, this method is RTL
sensitive and might reverse the result based on RTL state
|
boolean |
isSingleFocusMode()
Returns true if there is only one focusable member in this form.
|
boolean |
isSmoothScrolling()
Indicates that scrolling through the component should work as an animation
|
void |
keyPressed(int keyCode)
If this Component is focused, the key pressed event
will call this method
|
void |
keyReleased(int keyCode)
If this Component is focused, the key released event
will call this method
|
void |
keyRepeated(int keyCode)
If this Component is focused, the key repeat event
will call this method.
|
protected void |
longKeyPress(int keyCode)
If this Component is focused this method is invoked when the user presses
and holds the key
|
protected void |
longPointerPress(int x,
int y)
If this Component is focused this method is invoked when the user presses
and holds the pointer on the Component
|
protected void |
onShow()
Allows subclasses to bind functionality that occurs when
a specific form or dialog appears on the screen
|
protected void |
onShowCompleted()
Allows subclasses to bind functionality that occurs when
a specific form or dialog is "really" showing hence when
the transition is totally complete (unlike onShow which is called
on intent).
|
void |
paint(Graphics g)
This method paints the Component on the screen, it should be overriden
by subclasses to perform custom drawing or invoke the UI API's to let
the PLAF perform the rendering.
|
void |
paintBackground(Graphics g)
Exposing the background painting for the benefit of animations
|
protected String |
paramString()
Returns a string representing the state of this component.
|
void |
pointerDragged(int x,
int y)
If this Component is focused, the pointer dragged event
will call this method
|
void |
pointerHover(int[] x,
int[] y)
Invoked for devices where the pointer can hover without actually clicking
the display.
|
void |
pointerHoverReleased(int[] x,
int[] y)
Invoked for devices where the pointer can hover without actually clicking
the display.
|
void |
pointerPressed(int x,
int y)
If this Component is focused, the pointer pressed event
will call this method
|
void |
pointerReleased(int x,
int y)
If this Component is focused, the pointer released event
will call this method
|
void |
refreshTheme()
Makes sure the component is up to date with the current style object
|
void |
registerAnimated(Animation cmp)
The given component is interested in animating its appearance and will start
receiving callbacks when it is visible in the form allowing it to animate
its appearance.
|
void |
removeAll()
Removes all Components from the Content Pane
|
void |
removeAllCommands()
Clear menu commands from the menu bar
|
void |
removeCommand(Command cmd)
Removes the command from the menu bar softkeys
|
void |
removeCommandListener(ActionListener l)
A listener that is invoked when a command is clicked allowing multiple commands
to be handled by a single block
|
void |
removeComponent(Component cmp)
Removes a component from the Form's Content Pane
|
void |
removeGameKeyListener(int keyCode,
ActionListener listener)
Removes a game key listener from the given game keycode
|
void |
removeKeyListener(int keyCode,
ActionListener listener)
Removes a key listener from the given keycode
|
void |
removePointerDraggedListener(ActionListener l)
Removes the listener from the pointer event
|
void |
removePointerPressedListener(ActionListener l)
Removes the listener from the pointer event
|
void |
removePointerReleasedListener(ActionListener l)
Removes the listener from the pointer event
|
void |
replace(Component current,
Component next,
Transition t)
This method replaces the current Component with the next Component.
|
void |
replaceAndWait(Component current,
Component next,
Transition t)
This method replaces the current Component with the next Component.
|
void |
scrollComponentToVisible(Component c)
Makes sure the component is visible in the scroll if this container
is scrollable
|
void |
setBackCommand(Command backCommand)
Indicates the command that is defined as the back command out of this form.
|
void |
setBgImage(Image bgImage)
Sets the background image to show behind the form
|
void |
setClearCommand(Command clearCommand)
Indicates the command that is defined as the clear command in this form.
|
void |
setCommandListener(ActionListener commandListener)
Deprecated.
use add/removeCommandListener instead
|
void |
setCyclicFocus(boolean cyclicFocus)
Indicates whether focus should cycle within the form
|
void |
setDefaultCommand(Command defaultCommand)
Default command is invoked when a user presses fire, this functionality works
well in some situations but might collide with elements such as navigation
and combo boxes.
|
void |
setFocused(Component focused)
Sets the focused component and fires the appropriate events to make it so
|
void |
setFocusScrolling(boolean focusScrolling)
Indicates whether lists and containers should scroll only via focus and thus "jump" when
moving to a larger component as was the case in older versions of LWUIT.
|
void |
setGlassPane(Painter glassPane)
Allows a developer that doesn't derive from the form to draw on top of the
form regardless of underlying changes or animations.
|
void |
setLayout(Layout layout)
Sets the layout manager responsible for arranging this container
|
void |
setMenuCellRenderer(ListCellRenderer menuCellRenderer)
Determine the cell renderer used to render menu elements for themeing the
look of the menu options
|
void |
setMenuStyle(Style s)
Deprecated.
use setSoftButtonStyle instead
|
void |
setMenuTransitions(Transition transitionIn,
Transition transitionOut)
Sets the menu transitions for showing/hiding the menu, can be null...
|
void |
setRTL(boolean r)
Is the component a bidi RTL component
|
void |
setScrollable(boolean scrollable)
The equivalent of calling both setScrollableY and setScrollableX
|
void |
setScrollableX(boolean scrollableX)
Sets whether the component should/could scroll on the X axis
|
void |
setScrollableY(boolean scrollableY)
Sets whether the component should/could scroll on the Y axis
|
void |
setScrollAnimationSpeed(int animationSpeed)
Scroll animation speed in milliseconds allowing a developer to slow down or accelerate
the smooth animation mode
|
void |
setSmoothScrolling(boolean smoothScrolling)
Indicates that scrolling through the component should work as an animation
|
void |
setSoftButtonStyle(Style s)
Sets the style of the menu bar programmatically
|
void |
setTintColor(int tintColor)
Default color for the screen tint when a dialog or a menu is shown
|
void |
setTitle(String title)
Sets the Form title to the given text
|
void |
setTitleComponent(Label title)
Allows replacing the title with a different title component, thus allowing
developers to create more elaborate title objects.
|
void |
setTitleComponent(Label title,
Transition t)
Allows replacing the title with a different title component, thus allowing
developers to create more elaborate title objects.
|
void |
setTitleStyle(Style s)
Sets the style of the title programmatically
|
void |
setTransitionInAnimator(Transition transitionInAnimator)
This property allows us to define a an animation that will draw the transition for
entering this form.
|
void |
setTransitionOutAnimator(Transition transitionOutAnimator)
This property allows us to define a an animation that will draw the transition for
exiting this form.
|
void |
setVisible(boolean visible)
Toggles visibility of the component
|
void |
show()
Displays the current form on the screen
|
void |
showBack()
Displays the current form on the screen, this version of the method is
useful for "back" navigation since it reverses the direction of the transition.
|
protected Command |
showMenuDialog(Dialog menu)
A menu is implemented as a dialog, this method allows you to override dialog
display in order to customize the dialog menu in various ways
|
protected void |
showNotify()
This method is only invoked when the underlying canvas for the form is shown
this method isn't called for form based events and is generally usable for
suspend/resume based behavior
|
protected void |
sizeChanged(int w,
int h)
This method is only invoked when the underlying canvas for the form gets
a size changed event.
|
applyRTL, calcPreferredSize, contains, flushReplace, getComponentAt, getComponentAt, getComponentCount, getLayoutHeight, getLayoutWidth, getScrollIncrement, invalidate, isScrollableX, isScrollableY, layoutContainer, paintGlass, revalidate, setCellRenderer, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout
addFocusListener, animate, calcScrollSize, contains, deinitialize, deinitializeCustomStyle, dragInitiated, fireClicked, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getBaseline, getBaselineResizeBehavior, getBorder, getBottomGap, getBounds, getClientProperty, getDirtyRegion, getHeight, getLabelForComponent, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getParent, getPreferredH, getPreferredSize, getPreferredW, getScrollDimension, getScrollX, getScrollY, getSelectCommandText, getSelectedStyle, getSideGap, getStyle, getUIID, getUnselectedStyle, getVisibleBounds, getWidth, getX, getY, handlesInput, hasFocus, initComponent, initCustomStyle, isBorderPainted, isDragActivated, isEnabled, isFocusable, isFocusPainted, isInitialized, isRTL, isScrollable, isScrollVisible, isSelectableInteraction, isTactileTouch, isTactileTouch, isTensileDragEnabled, isVisible, laidOut, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintScrollbars, paintScrollbarX, paintScrollbarY, pointerDragged, pointerPressed, pointerReleased, putClientProperty, refreshTheme, removeFocusListener, repaint, repaint, requestFocus, scrollRectToVisible, scrollRectToVisible, setBorderPainted, setDirtyRegion, setEnabled, setFocus, setFocusable, setFocusPainted, setHandlesInput, setHeight, setInitialized, setIsScrollVisible, setLabelForComponent, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setPreferredH, setPreferredSize, setPreferredW, setScrollSize, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setStyle, setTactileTouch, setTensileDragEnabled, setUIID, setUnselectedStyle, setUnSelectedStyle, setWidth, setX, setY, styleChanged, toString
protected boolean focusScrolling
public Form()
public Form(String title)
title
- the form titlepublic void setMenuStyle(Style s)
s
- new stylepublic void setSoftButtonStyle(Style s)
s
- new stylepublic Style getSoftButtonStyle()
protected void hideNotify()
protected void showNotify()
protected void sizeChanged(int w, int h)
w
- the new width of the Formh
- the new height of the Formpublic void setGlassPane(Painter glassPane)
glassPane
- a new glass pane to install. It is generally recommended to
use a painter chain if more than one painter is required.public Painter getGlassPane()
PainterChain.installGlassPane(Form, com.sun.lwuit.Painter)
public void setTitleStyle(Style s)
s
- new stylepublic Label getTitleComponent()
public void setTitleComponent(Label title)
title
- new title componentpublic void setTitleComponent(Label title, Transition t)
title
- new title componentt
- transition for title replacementpublic void addKeyListener(int keyCode, ActionListener listener)
keyCode
- code on which to send the eventlistener
- listener to invoke when the key code released.public void removeKeyListener(int keyCode, ActionListener listener)
keyCode
- code on which the event is sentlistener
- listener instance to removepublic void removeGameKeyListener(int keyCode, ActionListener listener)
keyCode
- code on which the event is sentlistener
- listener instance to removepublic void addGameKeyListener(int keyCode, ActionListener listener)
keyCode
- code on which to send the eventlistener
- listener to invoke when the key code released.public int getSoftButtonCount()
public Button getSoftButton(int offset)
offset
- the offest of the softbuttonpublic Style getMenuStyle()
public Style getTitleStyle()
public void setDefaultCommand(Command defaultCommand)
defaultCommand
- the command to treat as defaultpublic Command getDefaultCommand()
public void setClearCommand(Command clearCommand)
clearCommand
- the command to treat as the clear Commandpublic Command getClearCommand()
public void setBackCommand(Command backCommand)
backCommand
- the command to treat as the back Commandpublic Command getBackCommand()
public Container getContentPane()
public void removeAll()
public void setBgImage(Image bgImage)
bgImage
- the background imagepublic void setLayout(Layout layout)
Container
public void setTitle(String title)
title
- the form titlepublic String getTitle()
public void addComponent(Component cmp)
addComponent
in class Container
cmp
- the added parampublic void addComponent(Object constraints, Component cmp)
Container
addComponent
in class Container
constraints
- this method is useful when the Layout requires a constraint
such as the BorderLayout.
In this case you need to specify an additional data when you add a Component,
such as "CENTER", "NORTH"...cmp
- component to addpublic void addComponent(int index, Object constraints, Component cmp)
Container
addComponent
in class Container
index
- location to insert the Componentconstraints
- this method is useful when the Layout requires a constraint
such as the BorderLayout.
In this case you need to specify an additional data when you add a Component,
such as "CENTER", "NORTH"...cmp
- component to addpublic void addComponent(int index, Component cmp)
addComponent
in class Container
cmp
- the added paramindex
- location to insert the Componentpublic void replace(Component current, Component next, Transition t)
Container
public void replaceAndWait(Component current, Component next, Transition t)
Container
replaceAndWait
in class Container
current
- a Component to remove from the Containernext
- a Component that replaces the current Componentt
- a Transition between the add and removal of the Components
a Transition can be nullpublic void removeComponent(Component cmp)
removeComponent
in class Container
cmp
- the component to be removedpublic final boolean hasMedia()
public void registerAnimated(Animation cmp)
cmp
- component that would be animatedpublic void deregisterAnimated(Animation cmp)
cmp
- component that would no longer receive animation eventspublic void refreshTheme()
Component
refreshTheme
in class Container
public void paintBackground(Graphics g)
paintBackground
in class Component
g
- the form graphicspublic Transition getTransitionInAnimator()
public void setTransitionInAnimator(Transition transitionInAnimator)
transitionInAnimator
- the Form in transitionpublic Transition getTransitionOutAnimator()
public void setTransitionOutAnimator(Transition transitionOutAnimator)
transitionOutAnimator
- the Form out transitionpublic void setCommandListener(ActionListener commandListener)
commandListener
- the command action listenerpublic void addCommandListener(ActionListener l)
l
- the command action listenerpublic void removeCommandListener(ActionListener l)
l
- the command action listenerprotected void actionCommand(Command cmd)
cmd
- the form commmand objectpublic void dispatchCommand(Command cmd, ActionEvent ev)
cmd
- The command to dispatchev
- the event to dispatchpublic void show()
public void showBack()
public void setSmoothScrolling(boolean smoothScrolling)
Component
setSmoothScrolling
in class Component
smoothScrolling
- indicates if a component uses smooth scrollingpublic boolean isSmoothScrolling()
Component
isSmoothScrolling
in class Component
public int getScrollAnimationSpeed()
Component
getScrollAnimationSpeed
in class Component
public void setScrollAnimationSpeed(int animationSpeed)
Component
setScrollAnimationSpeed
in class Component
animationSpeed
- scroll animation speed in millisecondsprotected void onShow()
protected void onShowCompleted()
public final Form getComponentForm()
Component
getComponentForm
in class Component
public void setFocused(Component focused)
focused
- the newly focused component or null for no focuspublic Component getFocused()
protected void longKeyPress(int keyCode)
Component
longKeyPress
in class Component
keyCode
- the key code value to indicate a physical key.protected void longPointerPress(int x, int y)
Component
longPointerPress
in class Component
public void keyPressed(int keyCode)
Component
keyPressed
in class Component
keyCode
- the key code value to indicate a physical key.public Layout getLayout()
Container
public void keyReleased(int keyCode)
Component
keyReleased
in class Component
keyCode
- the key code value to indicate a physical key.public void keyRepeated(int keyCode)
Component
keyRepeated
in class Component
keyCode
- the key code value to indicate a physical key.public void pointerPressed(int x, int y)
Component
pointerPressed
in class Container
x
- the pointer x coordinatey
- the pointer y coordinatepublic void addPointerPressedListener(ActionListener l)
l
- callback to receive pointer eventspublic void removePointerPressedListener(ActionListener l)
l
- callback to removepublic void addPointerReleasedListener(ActionListener l)
l
- callback to receive pointer eventspublic void removePointerReleasedListener(ActionListener l)
l
- callback to removepublic void addPointerDraggedListener(ActionListener l)
l
- callback to receive pointer eventspublic void removePointerDraggedListener(ActionListener l)
l
- callback to removepublic void pointerDragged(int x, int y)
Component
pointerDragged
in class Component
x
- the pointer x coordinatey
- the pointer y coordinatepublic void pointerHoverReleased(int[] x, int[] y)
Component
pointerHoverReleased
in class Component
x
- the pointer x coordinatey
- the pointer y coordinatepublic void pointerHover(int[] x, int[] y)
Component
pointerHover
in class Container
x
- the pointer x coordinatey
- the pointer y coordinatepublic boolean isSingleFocusMode()
public void pointerReleased(int x, int y)
Component
pointerReleased
in class Component
x
- the pointer x coordinatey
- the pointer y coordinatepublic void setScrollableY(boolean scrollableY)
Container
setScrollableY
in class Container
scrollableY
- whether the component should/could scroll on the Y axispublic void setScrollableX(boolean scrollableX)
Container
setScrollableX
in class Container
scrollableX
- whether the component should/could scroll on the X axispublic int getComponentIndex(Component cmp)
Container
getComponentIndex
in class Container
cmp
- the component to search forpublic void addCommand(Command cmd, int offset)
cmd
- the Form command to be addedoffset
- position in which the command is addedpublic int getCommandCount()
public Command getCommand(int index)
index
- offset of the commandpublic void addCommand(Command cmd)
cmd
- the Form command to be addedpublic void removeCommand(Command cmd)
cmd
- the Form command to be removedpublic void setCyclicFocus(boolean cyclicFocus)
cyclicFocus
- marks whether focus should cyclepublic boolean isCyclicFocus()
public void scrollComponentToVisible(Component c)
scrollComponentToVisible
in class Container
c
- the componant to be visiblepublic void setMenuCellRenderer(ListCellRenderer menuCellRenderer)
menuCellRenderer
- the menu cell rendererpublic void removeAllCommands()
protected Command createSelectCommand()
protected Command createMenuSelectCommand()
public void setRTL(boolean r)
Component
protected Command createMenuCancelCommand()
public void paint(Graphics g)
Component
public void setScrollable(boolean scrollable)
Container
setScrollable
in class Container
scrollable
- whether the component should/could scroll on the
X and Y axispublic void setVisible(boolean visible)
Component
setVisible
in class Component
visible
- true if component is visible; otherwise falsepublic int getTintColor()
public void setTintColor(int tintColor)
tintColor
- the tint color when a dialog or a menu is shownpublic void setMenuTransitions(Transition transitionIn, Transition transitionOut)
transitionIn
- the transition that will play when the menu appearstransitionOut
- the transition that will play when the menu is foldedprotected String paramString()
Component
null
.paramString
in class Container
protected Command showMenuDialog(Dialog menu)
menu
- a dialog containing menu options that can be customizedprotected boolean isReverseSoftButtons()
protected int calculateTouchCommandGridColumns(Container grid)
grid
- container that will be arranged in the grid containing the componentsprotected Button createTouchCommandButton(Command c)
c
- command to map into the returned buttonprotected Component createCommandComponent(Vector commands)
commands
- list of command objectsprotected List createCommandList(Vector commands)
commands
- list of command objectspublic boolean isFocusScrolling()
public void setFocusScrolling(boolean focusScrolling)
focusScrolling
- the new value for focus scrolling