net.rim.device.api.input
Class LookupProperties

java.lang.Object
  extended by net.rim.device.api.input.LookupProperties

public class LookupProperties
extends Object

Stores and sets a collection of lookup screen look-and-feel parameters.

Since:
BlackBerry API 6.0.0

Constructor Summary
LookupProperties()
          Constructs lookup screen properties object with default look-and-feel parameters.
 
Method Summary
 Background getPreferredBackground()
          Gets the current background object displayed for a lookup screen.
 Border getPreferredBorder()
          Gets the current border object for for a lookup screen.
 Font getPreferredFont()
          Gets a preferred font for a lookup screen.
 int getPreferredFontHeight()
          Gets preferred height of a font for a lookup screen.
 String getPreferredFontTypeface()
          Gets preferred typeface of a font for a lookup screen.
 int getPreferredForegroundColor()
          Gets foreground color for a lookup screen.
 int getPreferredIndent()
          Retrieves the number of indentation pixels for a lookup screen.
 XYEdges getPreferredMargin()
          Gets the margin outer-coordinates of a lookup screen.
 XYEdges getPreferredPadding()
          Retrieves the coordinates of a lookup screen's padding.
 Background getPreferredSelectedBackground()
          Gets the current background object displayed for a lookup screen.
 int getPreferredSelectedForegroundColor()
          Gets foreground color for a lookup screen.
 void setPreferredBackground(Background background)
          Sets a custom background for a lookup screen.
 void setPreferredBorder(Border brd)
          Sets a custom border for a lookup screen.
 void setPreferredFont(Font font)
          Sets a preferred font for a lookup screen.
 void setPreferredFontAttributes(String typeface, int height)
          Sets preferred typeface, style and height of a font for a lookup screen.
 void setPreferredFontHeight(int height)
          Sets preferred height of a font for a lookup screen.
 void setPreferredFontTypeface(String typeface)
          Sets preferred typeface of a font for a lookup screen.
 void setPreferredForegroundColor(int color)
          Sets foreground color for a lookup screen.
 void setPreferredIndent(int indentAmount)
          Sets the number of indentation pixels for a lookup screen.
 void setPreferredMargin(int top, int right, int bottom, int left)
          Sets the margin for a lookup screen.
 void setPreferredPadding(int top, int right, int bottom, int left)
          Sets the padding for a lookup screen.
 void setPreferredSelectedBackground(Background background)
          Sets a custom background for a lookup screen.
 void setPreferredSelectedForegroundColor(int color)
          Sets foreground color for a lookup screen.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

LookupProperties

public LookupProperties()
Constructs lookup screen properties object with default look-and-feel parameters.

Since:
BlackBerry API 6.0.0


Method Detail

setPreferredForegroundColor

public void setPreferredForegroundColor(int color)
Sets foreground color for a lookup screen.

Parameters:
color - Color to use in foreground.
Since:
BlackBerry API 6.0.0

getPreferredForegroundColor

public int getPreferredForegroundColor()
Gets foreground color for a lookup screen.

Returns:
A lookup screen's foreground color.
Since:
BlackBerry API 6.0.0

setPreferredSelectedForegroundColor

public void setPreferredSelectedForegroundColor(int color)
Sets foreground color for a lookup screen.

Parameters:
color - Color to use in foreground.
Since:
BlackBerry API 6.0.0

getPreferredSelectedForegroundColor

public int getPreferredSelectedForegroundColor()
Gets foreground color for a lookup screen.

Returns:
A lookup screen's foreground color.
Since:
BlackBerry API 6.0.0

setPreferredFont

public void setPreferredFont(Font font)
Sets a preferred font for a lookup screen.

Parameters:
font - New font for a lookup screen.
Since:
BlackBerry API 6.0.0

setPreferredFontAttributes

public void setPreferredFontAttributes(String typeface,
                                       int height)
Sets preferred typeface, style and height of a font for a lookup screen.

Parameters:
typeface - Name of the font family (for example: "BBSansSerif").
height - Desired height in pixels.
Since:
BlackBerry API 6.0.0

setPreferredFontTypeface

public void setPreferredFontTypeface(String typeface)
Sets preferred typeface of a font for a lookup screen.

Parameters:
typeface - Name of the font family (for example: "BBSansSerif").
Since:
BlackBerry API 6.0.0

setPreferredFontHeight

public void setPreferredFontHeight(int height)
Sets preferred height of a font for a lookup screen.

Parameters:
height - Desired height in pixels.
Since:
BlackBerry API 6.0.0

getPreferredFont

public Font getPreferredFont()
Gets a preferred font for a lookup screen.

Returns:
A lookup screen's current font.
Since:
BlackBerry API 6.0.0

getPreferredFontTypeface

public String getPreferredFontTypeface()
Gets preferred typeface of a font for a lookup screen.

Parameters:
typeface - Name of the font family (for example: "BBSansSerif").
Since:
BlackBerry API 6.0.0

getPreferredFontHeight

public int getPreferredFontHeight()
Gets preferred height of a font for a lookup screen.

Parameters:
height - Desired height in pixels.
Since:
BlackBerry API 6.0.0

setPreferredBackground

public void setPreferredBackground(Background background)
Sets a custom background for a lookup screen.

Parameters:
bgd - Background object to display, null to use default background.
Since:
BlackBerry API 6.0.0

getPreferredBackground

public Background getPreferredBackground()
Gets the current background object displayed for a lookup screen.

Returns:
Background object currently displayed, null if one does not exist.
Since:
BlackBerry API 6.0.0

setPreferredSelectedBackground

public void setPreferredSelectedBackground(Background background)
Sets a custom background for a lookup screen.

Parameters:
bgd - Background object to display, null to use default background.
Since:
BlackBerry API 6.0.0

getPreferredSelectedBackground

public Background getPreferredSelectedBackground()
Gets the current background object displayed for a lookup screen.

Returns:
Background object currently displayed, null if one does not exist.
Since:
BlackBerry API 6.0.0

setPreferredBorder

public void setPreferredBorder(Border brd)
Sets a custom border for a lookup screen.

Parameters:
border - Border object to display, null to use default border.
Since:
BlackBerry API 6.0.0

getPreferredBorder

public final Border getPreferredBorder()
Gets the current border object for for a lookup screen.

Returns:
Border object currently displayed, null if one does not exist.
Since:
BlackBerry API 6.0.0

setPreferredIndent

public void setPreferredIndent(int indentAmount)
Sets the number of indentation pixels for a lookup screen.

Parameters:
indentAmount - Number of indentation pixels.
Since:
BlackBerry API 6.0.0

getPreferredIndent

public int getPreferredIndent()
Retrieves the number of indentation pixels for a lookup screen.

Returns:
Number of indentation pixels.
Since:
BlackBerry API 6.0.0

setPreferredMargin

public void setPreferredMargin(int top,
                               int right,
                               int bottom,
                               int left)
Sets the margin for a lookup screen.

Parameters:
top - Top-most coordinate of the margin.
right - Right-most coordinate of the margin.
bottom - Bottom-most coordinate of the margin.
left - Left-most coordinate of the margin.
Since:
BlackBerry API 6.0.0

getPreferredMargin

public XYEdges getPreferredMargin()
Gets the margin outer-coordinates of a lookup screen.

Returns:
Eges margin object to receive the margin coordinates.
Since:
BlackBerry API 6.0.0

setPreferredPadding

public void setPreferredPadding(int top,
                                int right,
                                int bottom,
                                int left)
Sets the padding for a lookup screen.

Parameters:
top - Top-most padding coordinate.
right - Right-most padding coordinate.
bottom - Bottom-most padding coordinate.
left - Left-most padding coordinate.
Since:
BlackBerry API 6.0.0

getPreferredPadding

public XYEdges getPreferredPadding()
Retrieves the coordinates of a lookup screen's padding.

Parameters:
Edges - padding object to contain a lookup screen's padding coordinates.
Since:
BlackBerry API 6.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.