com.softwareag.mobile.runtime.toolkit.ui.styles

Class Style

java.lang.Object

com.softwareag.mobile.runtime.toolkit.ui.styles.Style

public class Style
extends java.lang.Object

A style is a container for common UI properties. Those properties can be specified once and then be reused for different UI elements.

All styles - specified in the application model - are stored as singleton instances and can be accessed using the application controller.

To create a custom style, subclass Style and apply properties according to your needs using the floating pattern. Use the apply(nUIDisplayObject) method to set properties to a dedicated UI element, e.g.:

 final Style style = ...;
 final nUIDisplayObject element = ...;
 style.setBackgroundColor(0xff00ff).setTextColor(0xffffff);
 style.apply(element);
 

Users are able to set each of the listed properties individually for a particular UI element using the application model. Therefore, properties which are not exposed in the model, can't be set using a Style.

Version:

9.12.0.0000-0266

Constructor Summary

Constructors

Constructor and Description
Style()

Method Summary

Modifier and Type	Method and Description
Style	apply(com.softwareag.mobile.runtime.nui.nUIDisplayObject element) Applies all non-null properties to the passed nUIDisplayObject.
java.lang.Integer	getBackgroundColor()
javax.microedition.lcdui.Image	getBackgroundImage()
java.lang.String	getDateFormat()
FontSize	getFontSize()
java.lang.Integer	getFontStyle()
java.lang.Integer	getHAlign()
java.lang.Integer	getHeaderBackgroundColor()
java.lang.Integer	getHeaderForegroundColor()
javax.microedition.lcdui.Image	getHeaderImage()
java.lang.Integer	getHeight()
java.lang.Boolean	getHScrollable()
java.lang.Integer	getInnerX()
java.lang.Integer	getInnerY()
java.lang.Integer	getInnerYSpacing()
java.lang.String	getInputType()
java.lang.Integer	getLines()
java.lang.Integer	getMaxLines()
java.lang.Integer	getMinLines()
java.lang.Boolean	getOverscrollingEnabled()
java.lang.Integer	getRenderType()
java.lang.Boolean	getScaleToFitEnabled()
java.lang.Integer	getSeparatorColor()
java.lang.Integer	getTextAlign()
java.lang.Integer	getTextClipType()
java.lang.Integer	getTextColor()
java.lang.Integer	getVAlign()
java.lang.Boolean	getVScrollable()
java.lang.Integer	getWidth()
java.lang.Integer	getX()
java.lang.Integer	getY()
Style	setBackgroundColor(int color) Sets the backgroundColor property.
Style	setBackgroundImage(javax.microedition.lcdui.Image image) Sets the backgroundImage property.
Style	setDateFormat(java.lang.String dateFormat) Sets the dateFormat property.
Style	setFontColor(int color) Sets the textColor property.
Style	setFontSize(FontSize fontSize) Sets the fontSize property.
Style	setFontStyle(int fontStyle) Sets the fontStyle property.
Style	setHAlign(int hAlign) Sets the hAlign property.
Style	setHeaderBackgroundColor(int color) Sets the headerBackgroundColor property.
Style	setHeaderForegroundColor(int color) Sets the headerForegroundColor property.
Style	setHeaderImage(javax.microedition.lcdui.Image image) Sets the headerImage property.
Style	setHeight(int height) Sets the height property.
Style	setHScrollable(boolean hScrollable) Sets the hScrollable property.
Style	setInnerX(int innerX) Sets the innerX property.
Style	setInnerY(int innerY) Sets the innerY property.
Style	setInnerYSpacing(int spacing) Sets the innerYSpacing property.
Style	setInputType(java.lang.String inputType) Sets the inputType property.
Style	setLines(int lines) Sets the lines property.
Style	setMaxLines(int maxLines) Sets the maxLines property.
Style	setMinLines(int minLines) Sets the minLines property.
Style	setOverscrollingEnabled(boolean overscrollingEnabled) Sets the overscrollingEnabled property.
Style	setParent(Style parent) Sets the parent Style.
Style	setRenderType(int renderType) Sets the renderType property.
Style	setScaleToFitEnabled(boolean scaleToFitEnabled) Sets the scaleToFitEnabled property.
Style	setSeparatorColor(int color) Sets the separatorColor property.
Style	setTextAlign(int textAlign) Sets the textAlign property.
Style	setTextClipType(int clipType) Sets the renderType property.
Style	setVAlign(int vAlign) Sets the vAlign property.
Style	setVScrollable(boolean vScrollable) Sets the vScrollable property.
Style	setWidth(int width) Sets the width property.
Style	setX(int x) Sets the x property.
Style	setY(int y) Sets the y property.

Methods inherited from class java.lang.Object

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

Constructor Detail

Style

public Style()

Method Detail

setBackgroundColor

public Style setBackgroundColor(int color)

Sets the backgroundColor property.

The passed value must be either a RGB (0xffffff) or ARGB (0xffffffff) value.

This property will be applied to:

• nUIDisplayObject.setBgcolor(int)

Parameters:

color -

Returns:

setBackgroundImage

public Style setBackgroundImage(javax.microedition.lcdui.Image image)

Sets the backgroundImage property.

Note that null values will not be taken into account.

This property will be applied to:

• nUIViewDisplay.setBgimage(Image)

Parameters:

image -

Returns:

setHScrollable

public Style setHScrollable(boolean hScrollable)

Sets the hScrollable property.

This property will be applied to:

• nUIContainerElement.setHscrollable(boolean)
• nUIViewDisplay.setHscrollable(boolean)

Parameters:

hScrollable -

Returns:

setVScrollable

public Style setVScrollable(boolean vScrollable)

Sets the vScrollable property.

This property will be applied to:

• nUIContainerElement.setVscrollable(boolean)
• nUIViewDisplay.setVscrollable(boolean)

Parameters:

vScrollable -

Returns:

setHeaderBackgroundColor

public Style setHeaderBackgroundColor(int color)

Sets the headerBackgroundColor property.

The passed value must be either a RGB (0xffffff) or ARGB (0xffffffff) value.

This property will be applied to:

• nUIViewDisplay.setHeaderBgcolor(int)

Parameters:

color -

Returns:

setHeaderForegroundColor

public Style setHeaderForegroundColor(int color)

Sets the headerForegroundColor property.

The passed value must be either a RGB (0xffffff) or ARGB (0xffffffff) value.

This property will be applied to:

• nUIViewDisplay.setHeaderFgColor(int)

Parameters:

color -

Returns:

setHeaderImage

public Style setHeaderImage(javax.microedition.lcdui.Image image)

Sets the headerImage property.

Note that null values will not be taken into account.

This property will be applied to:

• nUIViewDisplay.setHeaderimage(Image)

Parameters:

image -

Returns:

setFontColor

public Style setFontColor(int color)

Sets the textColor property.

The passed value must be either a RGB (0xffffff) or ARGB (0xffffffff) value.

This property will be applied to:

• nUITextfieldElement.setTextColor(int)
• nUIEntryElement.setTextColor(int)
• nUIButtonElement.setTextColor(int)

Parameters:

color -

Returns:

setFontSize

public Style setFontSize(FontSize fontSize)

Sets the fontSize property.

The passed value must be an instance of AbsoluteFontSize or RelativeFontSize.

This property will be applied to:

• nUITextfieldElement.setFontSizeRelative(int, int)
• nUITextfieldElement.setFontSizeAbsolute(int, boolean)
• nUIEntryElement.setFontSizeRelative(int, int)
• nUIEntryElement.setFontSizeAbsolute(int, boolean)
• nUIButtonElement.setFontSizeRelative(int, int)
• nUIButtonElement.setFontSizeAbsolute(int, boolean)

Parameters:

fontSize -

Returns:

setFontStyle

public Style setFontStyle(int fontStyle)

Sets the fontStyle property.

Possible values are defined in nUIConstants:

• nUIConstants.style_bold
• nUIConstants.style_default
• nUIConstants.style_italic
• nUIConstants.style_underlined

This property will be applied to:

• nUITextfieldElement.setFontStyle(int)
• nUIEntryElement.setFontStyle(int)
• nUIButtonElement.setFontStyle(int)

Parameters:

fontStlye -

Returns:

setHAlign

public Style setHAlign(int hAlign)

Sets the hAlign property.

Possible values are defined in nUIConstants:

• nUIConstants.center
• nUIConstants.centre
• nUIConstants.left
• nUIConstants.right

This property will be applied to:

• nUIImageElement.setAlign(int)

Parameters:

hAlign -

Returns:

setVAlign

public Style setVAlign(int vAlign)

Sets the vAlign property.

Possible values are defined in nUIConstants:

• nUIConstants.center
• nUIConstants.centre
• nUIConstants.top
• nUIConstants.bottom

This property will be applied to:

• nUITablecellElement.setVAlign(int)

Parameters:

vAlign -

Returns:

setTextAlign

public Style setTextAlign(int textAlign)

Sets the textAlign property.

Possible values are defined in nUIConstants:

• nUIConstants.center
• nUIConstants.left
• nUIConstants.right

This property will be applied to:

• nUITextfieldElement.setHAlign(int)
• nUIButtonElement.setTextalign(int)
• nUIDateEntry#setTextalign(int)
• nUIDropdownlistEntry#setTextalign(int)

Parameters:

textAlign -

Returns:

setMaxLines

public Style setMaxLines(int maxLines)

Sets the maxLines property.

This property will be applied to:

• nUITextfieldElement.setMaxLines(int)

Parameters:

maxLines -

Returns:

setMinLines

public Style setMinLines(int minLines)

Sets the minLines property.

This property will be applied to:

• nUITextfieldElement.setMinLines(int)

Parameters:

minLines -

Returns:

setLines

public Style setLines(int lines)

Sets the lines property. This property will be applied to:

• nUIEntryElement.setLines(int)

Parameters:

lines -

Returns:

setInnerX

public Style setInnerX(int innerX)

Sets the innerX property.

The passed int value must be greater or equal to zero.

This property will be applied to:

• nUIDisplayObject.setInnerX(int)
• nUIDisplayObject.setInnerX(int)
• nUIDisplayObject.setInnerX(int)

Parameters:

innerX -

Returns:

setInnerY

public Style setInnerY(int innerY)

Sets the innerY property.

The passed int value must be greater or equal to zero.

This property will be applied to:

• nUIDisplayObject.setInnerY(int)
• nUIDisplayObject.setInnerY(int)
• nUIDisplayObject.setInnerY(int)

Parameters:

innerY -

Returns:

setInnerYSpacing

public Style setInnerYSpacing(int spacing)

Sets the innerYSpacing property.

The passed int value must be greater or equal to zero.

This property will be applied to:

• nUIViewDisplay#setInterElementYSpacing(int))

Parameters:

innerY -

Returns:

setX

public Style setX(int x)

Sets the x property.

The passed int value must be greater or equal to zero.

Parameters:

x -

Returns:

setY

public Style setY(int y)

Sets the y property.

The passed int value must be greater or equal to zero.

Parameters:

y -

Returns:

setWidth

public Style setWidth(int width)

Sets the width property.

The passed int value must be greater or equal to zero.

Parameters:

width -

Returns:

setHeight

public Style setHeight(int height)

Sets the height property.

The passed int value must be greater or equal to zero.

Parameters:

height -

Returns:

setRenderType

public Style setRenderType(int renderType)

Sets the renderType property.

Possible values are defined in nUITextfieldElement:

• nUITextfieldElement.RENDER_TYPE_PLAIN_TEXT
• nUITextfieldElement.RENDER_TYPE_HYPERLINKS

This property will be applied to:

• nUITextfieldElement.setRenderType(int)

Parameters:

renderType -

Returns:

setTextClipType

public Style setTextClipType(int clipType)

Sets the renderType property.

Possible values are defined in nUITextfieldElement:

• nUITextfieldElement.CLIP_TYPE_CLIP
• nUITextfieldElement.CLIP_TYPE_ELLIPSIS

This property will be applied to:

• nUITextfieldElement.setClipType(int)

Parameters:

renderType -

Returns:

setInputType

public Style setInputType(java.lang.String inputType)

Sets the inputType property.

Possible values are defined in nUIEntryElement:

• nUIEntryElement.FORMAT_STRING_ANY
• nUIEntryElement.FORMAT_NUMBER_ANY
• nUIEntryElement.FORMAT_STRING_HIDDEN
• nUIEntryElement.FORMAT_NUMBER_HIDDEN

This property will be applied to:

• nUIEntryElement.setFormat(String)

Parameters:

inputType -

Returns:

setDateFormat

public Style setDateFormat(java.lang.String dateFormat)

Sets the dateFormat property.

Possible values are defined in nUIDateEntry:

• nUIDateEntry.dd_MM_yyyy
• nUIDateEntry.MM_dd_yyyy
• nUIDateEntry.yyyy_MM_dd
• nUIDateEntry.HH_mm_ss
• nUIDateEntry.HH_mm

This property will be applied to:

• nUIDateEntry.setFormat(String)

Parameters:

dateFormat -

Returns:

setOverscrollingEnabled

public Style setOverscrollingEnabled(boolean overscrollingEnabled)

Sets the overscrollingEnabled property.

This property will be applied to:

• nUIWebviewElement.setOverscrollingEnabled(boolean)
• nUIWebView.setOverscrollingEnabled(boolean)

Parameters:

overscrollingEnabled -

Returns:

setScaleToFitEnabled

public Style setScaleToFitEnabled(boolean scaleToFitEnabled)

Sets the scaleToFitEnabled property.

This property will be applied to:

• nUIWebviewElement.setScaleToFitEnabled(boolean)
• nUIWebView.setScaleToFitEnabled(boolean)

Parameters:

scaleToFitEnabled -

Returns:

setSeparatorColor

public Style setSeparatorColor(int color)

Sets the separatorColor property.

The passed value must be either a RGB (0xffffff) or ARGB (0xffffffff) value.

This property will be applied to:

• nUISeparatorElement.setColor(int)

Parameters:

color -

Returns:

setParent

public Style setParent(Style parent)

Sets the parent Style.

Parameters:

parent -

Returns:

getBackgroundColor

public java.lang.Integer getBackgroundColor()

getBackgroundImage

public javax.microedition.lcdui.Image getBackgroundImage()

getHScrollable

public java.lang.Boolean getHScrollable()

getVScrollable

public java.lang.Boolean getVScrollable()

getHeaderBackgroundColor

public java.lang.Integer getHeaderBackgroundColor()

getHeaderForegroundColor

public java.lang.Integer getHeaderForegroundColor()

getHeaderImage

public javax.microedition.lcdui.Image getHeaderImage()

getTextColor

public java.lang.Integer getTextColor()

getFontSize

public FontSize getFontSize()

getFontStyle

public java.lang.Integer getFontStyle()

getHAlign

public java.lang.Integer getHAlign()

getVAlign

public java.lang.Integer getVAlign()

getTextAlign

public java.lang.Integer getTextAlign()

getMaxLines

public java.lang.Integer getMaxLines()

getMinLines

public java.lang.Integer getMinLines()

getLines

public java.lang.Integer getLines()

getInnerX

public java.lang.Integer getInnerX()

getInnerY

public java.lang.Integer getInnerY()

getInnerYSpacing

public java.lang.Integer getInnerYSpacing()

getX

public java.lang.Integer getX()

getY

public java.lang.Integer getY()

getWidth

public java.lang.Integer getWidth()

getHeight

public java.lang.Integer getHeight()

getRenderType

public java.lang.Integer getRenderType()

getTextClipType

public java.lang.Integer getTextClipType()

getDateFormat

public java.lang.String getDateFormat()

getInputType

public java.lang.String getInputType()

getOverscrollingEnabled

public java.lang.Boolean getOverscrollingEnabled()

getScaleToFitEnabled

public java.lang.Boolean getScaleToFitEnabled()

getSeparatorColor

public java.lang.Integer getSeparatorColor()

apply

public Style apply(com.softwareag.mobile.runtime.nui.nUIDisplayObject element)

Applies all non-null properties to the passed nUIDisplayObject.

Parameters:

element -

Returns: