de.enough.polish.ui
Class Spacer

java.lang.Object
  de.enough.polish.ui.Item
      de.enough.polish.ui.Spacer

public class Spacer
extends Item

A blank, non-interactive item that has a settable minimum size.

The usage of the Spacer item is discouraged for applications which use J2ME Polish, since margins and paddings can be set for each item anyhow.

The minimum width is useful for allocating flexible amounts of space between Items within the same row of a Form. The minimum height is useful for enforcing a particular minimum height of a row. The application can set the minimum width or height to any non-negative value. The implementation may enforce implementation-defined maximum values for the minimum width and height.

The unlocked preferred width of a Spacer is the same as its current minimum width. Its unlocked preferred height is the same as its current minimum height.

Since a Spacer's primary purpose is to position other items, it is restricted to be non-interactive, and the application is not allowed to add Commands to a Spacer. Since the presence of a label on an Item may affect layout in device-specific ways, the label of a Spacer is restricted to always be null, and the application is not allowed to change it.

Since:

MIDP 2.0

Author:

Robert Virkus, robert@enough.de

Field Summary

Fields inherited from class de.enough.polish.ui.Item

_bbField, _bbFieldAdded, appearanceMode, background, backgroundHeight, backgroundWidth, backgroundYOffset, border, borderWidth, BUTTON, colSpan, commands, completeBackground, completeBackgroundPadding, completeBorder, contentHeight, contentWidth, contentX, contentY, cssSelector, defaultCommand, focusedStyle, HORIZONTAL, HYPERLINK, includeLabel, INTERACTIVE, internalHeight, internalWidth, internalX, internalY, isFocused, isInitialized, isInvisible, isLayoutCenter, isLayoutExpand, isLayoutRight, isPressed, isShown, isStyleInitialised, itemCommandListener, itemHeight, itemWidth, label, labelStyle, layout, LAYOUT_2, LAYOUT_BOTTOM, LAYOUT_CENTER, LAYOUT_DEFAULT, LAYOUT_EXPAND, LAYOUT_LEFT, LAYOUT_NEWLINE_AFTER, LAYOUT_NEWLINE_BEFORE, LAYOUT_RIGHT, LAYOUT_SHRINK, LAYOUT_TOP, LAYOUT_VCENTER, LAYOUT_VEXPAND, LAYOUT_VSHRINK, marginBottom, marginLeft, marginRight, marginTop, maximumHeight, maximumWidth, minimumHeight, minimumWidth, NO_POSITION_SET, opacity, opacityPaintNormally, opacityRgbData, paddingBottom, paddingHorizontal, paddingLeft, paddingRight, paddingTop, paddingVertical, parent, PLAIN, preferredHeight, preferredWidth, preserveViewType, relativeX, relativeY, rowSpan, screen, style, TRANSPARENT, useSingleRow, VERTICAL, view

Constructor Summary

Spacer(int minWidth, int minHeight)
Creates a new Spacer with the given minimum size.

Method Summary

void	addCommand(javax.microedition.lcdui.Command cmd) Spacers are restricted from having Commands, so this method will always throw IllegalStateException whenever it is called.
protected java.lang.String	createCssSelector() Retrieves the CSS selector for this item.
protected void	initContent(int firstLineWidth, int lineWidth) Initialises this item.
void	paintContent(int x, int y, int leftBorder, int rightBorder, javax.microedition.lcdui.Graphics g) Paints the content of this item.
void	setDefaultCommand(javax.microedition.lcdui.Command cmd) Spacers are restricted from having Commands, so this method will always throw IllegalStateException whenever it is called.
void	setLabel(java.lang.String label) Spacers are restricted to having null labels, so this method will always throw IllegalStateException whenever it is called.
void	setMinimumSize(int minWidth, int minHeight) Sets the minimum size for this spacer.

Methods inherited from class de.enough.polish.ui.Item

addCommand, addCommands, addRelativeToBackgroundRegion, addRelativeToBackgroundRegion, addRelativeToContentRegion, animate, animate, containsCommand, defocus, focus, getAbsoluteX, getAbsoluteY, getAppearanceMode, getAttribute, getAttributes, getBackgroundHeight, getBackgroundWidth, getBackgroundX, getBackgroundY, getContentHeight, getContentWidth, getContentX, getContentY, getDefaultCommand, getFocusedStyle, getItemAt, getItemCommandListener, getItemCommands, getItemHeight, getItemStateListener, getItemWidth, getLabel, getLabelItem, getLayout, getMinimumHeight, getMinimumWidth, getParent, getPreferredHeight, getPreferredWidth, getScreen, getStyle, handleCommand, handleKeyPressed, handleKeyReleased, handleKeyRepeated, handlePointerPressed, handlePointerReleased, hideNotify, init, initStyle, isInContentArea, isInItemArea, isInItemArea, isInitialized, isVisible, notifyItemPressedEnd, notifyItemPressedStart, notifyStateChanged, paint, paintBackground, paintBackgroundAndBorder, paintBorder, releaseResources, removeCommand, repaint, repaint, repaintFully, requestInit, setAppearanceMode, setAttribute, setItemCommandListener, setItemCommandListener, setItemStateListener, setLayout, setParent, setParent, setPreferredSize, setStyle, setVisible, show, showCommands, showNotify, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Spacer

public Spacer(int minWidth,
              int minHeight)

Creates a new Spacer with the given minimum size. The Spacer's label is null. The minimum size must be zero or greater. If minWidth is greater than the implementation-defined maximum width, the maximum width will be used instead. If minHeight is greater than the implementation-defined maximum height, the maximum height will be used instead.

Parameters:

minWidth - - the minimum width in pixels

minHeight - - the minimum height in pixels

Throws:

java.lang.IllegalArgumentException - - if either minWidth or minHeight is less than zero

Method Detail

setMinimumSize

public void setMinimumSize(int minWidth,
                           int minHeight)

Sets the minimum size for this spacer. The Form will not be allowed to make the item smaller than this size. The minimum size must be zero or greater. If minWidth is greater than the implementation-defined maximum width, the maximum width will be used instead. If minHeight is greater than the implementation-defined maximum height, the maximum height will be used instead.

Parameters:

minWidth - - the minimum width in pixels

minHeight - - the minimum height in pixels

Throws:

java.lang.IllegalArgumentException - - if either minWidth or minHeight is less than zero

addCommand

public void addCommand(javax.microedition.lcdui.Command cmd)

Spacers are restricted from having Commands, so this method will always throw IllegalStateException whenever it is called.

Overrides:

addCommand in class Item

Parameters:

cmd - - the Command

Throws:

java.lang.IllegalStateException - - always

See Also:

in class Item

setDefaultCommand

public void setDefaultCommand(javax.microedition.lcdui.Command cmd)

Spacers are restricted from having Commands, so this method will always throw IllegalStateException whenever it is called.

Overrides:

setDefaultCommand in class Item

Parameters:

cmd - - the Command

Throws:

java.lang.IllegalStateException - - always

See Also:

in class Item

setLabel

public void setLabel(java.lang.String label)

Spacers are restricted to having null labels, so this method will always throw IllegalStateException whenever it is called.

Overrides:

setLabel in class Item

Parameters:

label - - the label string

Throws:

java.lang.IllegalStateException - - always

See Also:

in class Item

paintContent

public void paintContent(int x,
                         int y,
                         int leftBorder,
                         int rightBorder,
                         javax.microedition.lcdui.Graphics g)

Description copied from class: Item

Paints the content of this item. The background has already been painted and the border will be added after this method returns.

Specified by:

paintContent in class Item

Parameters:

x - the left start position

y - the upper start position

leftBorder - the left border, nothing must be painted left of this position

rightBorder - the right border, nothing must be painted right of this position

g - the Graphics on which this item should be painted.

initContent

protected void initContent(int firstLineWidth,
                           int lineWidth)

Description copied from class: Item

Initialises this item. The implementation needs to calculate and set the contentWidth and contentHeight fields. The implementation should take the fields preferredWidth and preferredHeight into account.

Specified by:

initContent in class Item

Parameters:

firstLineWidth - the maximum width of the first line

lineWidth - the maximum width of any following lines

See Also:

Item.contentWidth, Item.contentHeight, Item.preferredWidth, Item.preferredHeight

createCssSelector

protected java.lang.String createCssSelector()

Description copied from class: Item

Retrieves the CSS selector for this item. The CSS selector is used for the dynamic assignment of styles - that is the styles are assigned by the usage of the item and not by a predefined style-name. With the #style preprocessing command styles are set fix, this method yields in a faster GUI and is recommended. When in a style-sheet dynamic styles are used, e.g. "Form>p", than the selector of the item is needed.
This abstract method needs only be implemented, when dynamic styles are used: #ifdef polish.useDynamicStyles
The returned selector needs to be in lower case.

Specified by:

createCssSelector in class Item

Returns:

the appropriate CSS selector for this item. The selector needs to be in lower case.