|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.rim.device.api.ui.Field
net.rim.device.api.ui.component.TextField
net.rim.device.api.ui.component.RichTextField
net.rim.device.api.ui.component.ActiveRichTextField
com.sybase.uep.bobclient.controls.HyperLinkRichField
public class HyperLinkRichField
This is the hyper link control. This difference between HyperLinkRichField and HyperLink is that this will use Blackberries rich context matching to handle phone and email options.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class net.rim.device.api.ui.component.ActiveRichTextField |
---|
net.rim.device.api.ui.component.ActiveRichTextField.RegionQueue |
Field Summary |
---|
Fields inherited from class net.rim.device.api.ui.component.ActiveRichTextField |
---|
_cookieID, INVALID_COOKIE_ID, SCANFLAG_DISABLE_ALL_THREADING, SCANFLAG_THREAD_ON_CREATE |
Fields inherited from class net.rim.device.api.ui.component.RichTextField |
---|
TEXT_ALIGN_HCENTER, TEXT_ALIGN_LEFT, TEXT_ALIGN_RIGHT, USE_TEXT_WIDTH |
Fields inherited from class net.rim.device.api.ui.component.TextField |
---|
CONSUME_INPUT, DEFAULT_MAXCHARS, JUMP_FOCUS_AT_END, NO_COMPLEX_INPUT, NO_EDIT_MODE_INPUT, NO_LEARNING, NO_NEWLINE, NO_SWITCHING_INPUT |
Fields inherited from class net.rim.device.api.ui.Field |
---|
ACTION_INVOKE, EDITABLE, EDITABLE_MASK, FIELD_BOTTOM, FIELD_HALIGN_MASK, FIELD_HCENTER, FIELD_LEADING, FIELD_LEFT, FIELD_RIGHT, FIELD_TOP, FIELD_TRAILING, FIELD_VALIGN_MASK, FIELD_VCENTER, FOCUSABLE, FOCUSABLE_MASK, HIGHLIGHT_FOCUS, HIGHLIGHT_SELECT, NON_FOCUSABLE, NON_SPELLCHECKABLE, READONLY, SPELLCHECKABLE, SPELLCHECKABLE_MASK, STATUS_MOVE_FOCUS_HORIZONTALLY, STATUS_MOVE_FOCUS_VERTICALLY, USE_ALL_HEIGHT, USE_ALL_WIDTH, VISUAL_STATE_ACTIVE, VISUAL_STATE_DISABLED, VISUAL_STATE_DISABLED_FOCUS, VISUAL_STATE_FOCUS, VISUAL_STATE_NORMAL |
Fields inherited from interface net.rim.device.api.ui.DrawStyle |
---|
BASELINE, BOTTOM, ELLIPSIS, HALIGN_MASK, HCENTER, HDEFAULT, HFULL, LEADING, LEFT, RIGHT, TOP, TRAILING, TRUNCATE_BEGINNING, VALIGN_MASK, VCENTER, VDEFAULT, VFULL |
Constructor Summary | |
---|---|
HyperLinkRichField(int labelRID,
long style)
HyperLinkRichField constructor |
|
HyperLinkRichField(int labelRID,
long style,
boolean showBackgroundColor)
HyperLinkRichField constructor |
|
HyperLinkRichField(java.lang.String label,
long style)
HyperLinkRichField constructor |
|
HyperLinkRichField(java.lang.String label,
long style,
boolean showBackgroundColor)
HyperLinkRichField constructor |
Method Summary | |
---|---|
protected void |
drawFocus(net.rim.device.api.ui.Graphics g,
boolean on)
(non-Javadoc) |
IBOBAction |
getAction()
Retrieve the action assigned to this hyperlink |
int |
getColSpan()
(non-Javadoc) |
FontStyle |
getFocusFontStyle()
Retrieve focus font style |
long |
getHorizontalAlignment()
(non-Javadoc) |
int |
getHyperLinkWidth()
Retrieve hyperlink width |
java.lang.String |
getName()
(non-Javadoc) |
int |
getPreferredHeight()
(non-Javadoc) |
int |
getPreferredWidth()
(non-Javadoc) |
int |
getRowSpan()
(non-Javadoc) |
FontStyle |
getUnfocusFontStyle()
Retrieve unfocus font style |
java.lang.Object |
getValue()
(non-Javadoc) |
long |
getVerticalAlignment()
(non-Javadoc) |
protected void |
layout(int width,
int height)
(non-Javadoc) |
protected void |
makeContextMenu(net.rim.device.api.ui.ContextMenu menu)
(non-Javadoc) |
protected void |
onUnfocus()
Invoked when a field loses the focus |
protected void |
paint(net.rim.device.api.ui.Graphics g)
(non-Javadoc) |
void |
refresh()
(non-Javadoc) |
void |
refreshFooter(java.lang.String valueToBeDisplay)
Refresh the footer field from the screen that contains the text of the button. |
void |
runAction()
Run the action assigned to this hyperlink |
void |
setAction(IBOBAction action)
Set the action assigned to this hyperlink |
void |
setBackgroundColor(int bgcolor)
(non-Javadoc) |
void |
setColSpan(int colspan)
(non-Javadoc) |
void |
setFocusFontStyle(FontStyle fontStyle)
Set the focus font style for this control |
void |
setFooterField(FooterField field)
Set the footer field |
void |
setLayoutHeight(int height)
(non-Javadoc) |
void |
setLayoutWidth(int width)
(non-Javadoc) |
void |
setProperty(int key,
java.lang.String value)
Set the property values for this hyperlink |
void |
setRowSpan(int rowspan)
(non-Javadoc) |
void |
setText(java.lang.String text)
Set the label value ActiveRichTextField: different method signature than LabelField |
void |
setUnfocusFontStyle(FontStyle fontStyle)
Set the unfocus font style for this control |
void |
setVariableLabel(ControlVariable variable)
Set the control variable object for the label |
Methods inherited from class net.rim.device.api.ui.component.ActiveRichTextField |
---|
drawText, executeBackgroundScan, getContextMenuContext, getCookieWithFocus, getFocusRect, getMainScreenManager, getRegionCookie, getRegionCookie, getScanFlags, getText, invokeAction, keyDown, regionHasCookie, regionHasCookie, scrollVertically, selectionCopy, setAttributes, setScanFlags, setText, setText, setText, setText |
Methods inherited from class net.rim.device.api.ui.component.RichTextField |
---|
charAt, getAttributes, getBackgroundColors, getCursorPosition, getFonts, getFonts, getForegroundColors, getOffsets, getRegion, getRegionFont, getRegionFont, getRegionText, getRegionText, getText, getTextLength, isSelectable, keyChar, moveFocus, setCursorPosition, setFont, setFont, setText, setText |
Methods inherited from class net.rim.device.api.ui.component.TextField |
---|
backspace, backspace, backspace, clear, displayFieldFullMessage, drawText, fieldChangeNotify, getAccessibleContext, getComposedTextEnd, getComposedTextStart, getDisplayLineCount, getFilter, getLabel, getLabelLength, getMaxSize, getText, getText, getTextAbstractString, insert, insert, insert, insert, insert, insert, insert, isPasteable, isSelecting, isSelectionCopyable, isSelectionDeleteable, isSymbolScreenAllowed, keyControl, moveFocus, navigationClick, navigationUnclick, onFocus, onUndisplay, paste, select, selectionDelete, setCursorPosition, setFilter, setLabel, setMaxSize, setPreLayoutInternal, setSelection, setText, toString, update, wipe |
Methods inherited from class net.rim.device.api.ui.Field |
---|
drawHighlightRegion, focusAdd, focusChangeNotify, focusRemove, getBackground, getBackground, getBorder, getBorder, getBorder, getChangeListener, getContentHeight, getContentLeft, getContentRect, getContentRect, getContentTop, getContentWidth, getContextMenu, getContextMenu, getCookie, getExtent, getExtent, getFieldStyle, getFocusListener, getFont, getHeight, getIndex, getLeafFieldWithFocus, getLeft, getManager, getMargin, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getOriginal, getPadding, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getScreen, getState, getStyle, getTop, getVisualState, getWidth, invalidate, invalidate, invalidateAll, isDataValid, isDirty, isEditable, isFocus, isFocusable, isMuddy, isSelectionCutable, isSpellCheckable, isStyle, isVisible, keyRepeat, keyStatus, keyUp, makeContextMenu, navigationMovement, onDisplay, onExposed, onMenuDismissed, onMenuDismissed, onObscured, onVisibilityChange, paintBackground, selectionCut, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCookie, setDirty, setEditable, setExtent, setFocus, setFocusListener, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPadding, setPadding, setPosition, setVisualState, touchEvent, trackwheelClick, trackwheelUnclick, updateLayout |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface net.rim.device.internal.ui.Formatter.TextRenderer |
---|
getFont |
Constructor Detail |
---|
public HyperLinkRichField(int labelRID, long style)
labelRID
- int
value for the localization resource ID of the label value to be displayedstyle
- long
value for the style of this control
eg. Field.FIELD_LEFT
, Field.FIELD_RIGHT
, Field.FIELD_HCENTER
, etc.Field
public HyperLinkRichField(java.lang.String label, long style)
label
- String
value for the label to be displayedstyle
- long
value for the style of this control
eg. Field.FIELD_LEFT
, Field.FIELD_RIGHT
, Field.FIELD_HCENTER
, etc.Field
public HyperLinkRichField(int labelRID, long style, boolean showBackgroundColor)
labelRID
- int
value for the localization resource ID of the label value to be displayedstyle
- long
value for the style of this control
eg. Field.FIELD_LEFT
, Field.FIELD_RIGHT
, Field.FIELD_HCENTER
, etc.showBackgroundColor
- true
to show background color, otherwise false
Field
public HyperLinkRichField(java.lang.String label, long style, boolean showBackgroundColor)
label
- String
value for the label to be displayedstyle
- long
value for the style of this control
eg. Field.FIELD_LEFT
, Field.FIELD_RIGHT
, Field.FIELD_HCENTER
, etc.showBackgroundColor
- true
to show background color, otherwise false
Field
Method Detail |
---|
protected void makeContextMenu(net.rim.device.api.ui.ContextMenu menu)
makeContextMenu
in class net.rim.device.api.ui.component.TextField
Field.makeContextMenu(ContextMenu menu)
public void setBackgroundColor(int bgcolor)
setBackgroundColor
in interface Control
bgcolor
- int
value of the color in HEX.
For example: 0x00000000, 0x00FF0000, 0x00FFFFFFControl.setBackgroundColor(int bgcolor)
public void setColSpan(int colspan)
setColSpan
in interface Control
colspan
- int
value of the column spanControl.setColSpan(int colspan)
public int getColSpan()
getColSpan
in interface Control
int
value of the column spanControl.getColSpan()
public void setRowSpan(int rowspan)
setRowSpan
in interface Control
rowspan
- int
value of the row spanControl.setRowSpan(int rowspan)
public int getRowSpan()
getRowSpan
in interface Control
int
value of the row spanControl.getRowSpan()
public long getHorizontalAlignment()
getHorizontalAlignment
in interface Control
long
value of the horizontal alignment.
Possible values could be Field.FIELD_HCENTER, Field.FIELD_RIGHT, or Field.FIELD_LEFTControl.getHorizontalAlignment()
public long getVerticalAlignment()
getVerticalAlignment
in interface Control
long
value of the vertical alignment
Possible values could be Field.FIELD_TOP, Field.FIELD_BOTTOM, or Field.FIELD_VCENTERControl.getVerticalAlignment()
public void setVariableLabel(ControlVariable variable)
variable
- ControlVariable
control variable objectControlVariable
public FontStyle getUnfocusFontStyle()
FontStyle
font style objectFontStyle
public void setUnfocusFontStyle(FontStyle fontStyle)
fontStyle
- FontStyle
font style objectFontStyle
public FontStyle getFocusFontStyle()
FontStyle
font style objectFontStyle
public void setFocusFontStyle(FontStyle fontStyle)
fontStyle
- FontStyle
font style objectFontStyle
public java.lang.String getName()
getName
in interface Control
String
value of the key nameControl.getName()
public java.lang.Object getValue()
getValue
in interface Control
Object
of the value set for this controlControl.getValue()
public IBOBAction getAction()
IBOBAction
action to performIBOBAction
public void setAction(IBOBAction action)
action
- IBOBAction
action object to be perform when the hyperlink is clicked onIBOBAction
public void runAction()
public void setText(java.lang.String text)
setText
in class net.rim.device.api.ui.component.ActiveRichTextField
text
- String
value for the labelpublic void setLayoutWidth(int width)
setLayoutWidth
in interface Control
width
- int
value of the available layout widthControl.setLayoutWidth(int width)
public void setLayoutHeight(int height)
setLayoutHeight
in interface Control
height
- int
value of the available layout heightControl.setLayoutHeight(int height)
public int getPreferredWidth()
getPreferredWidth
in interface Control
getPreferredWidth
in class net.rim.device.api.ui.component.TextField
int
value of the available layout widthControl.getPreferredWidth()
public int getHyperLinkWidth()
int
value for the width link textpublic int getPreferredHeight()
getPreferredHeight
in interface Control
getPreferredHeight
in class net.rim.device.api.ui.component.RichTextField
int
value of the available layout heightControl.getPreferredHeight()
protected void layout(int width, int height)
layout
in class net.rim.device.api.ui.component.RichTextField
Field.layout(int width, int height)
protected void drawFocus(net.rim.device.api.ui.Graphics g, boolean on)
drawFocus
in class net.rim.device.api.ui.component.ActiveRichTextField
Field.drawFocus(Graphics g, boolean on)
protected void onUnfocus()
onUnfocus
in class net.rim.device.api.ui.Field
protected void paint(net.rim.device.api.ui.Graphics g)
paint
in class net.rim.device.api.ui.component.RichTextField
Field.paint(Graphics g)
public void refresh()
refresh
in interface Control
Control.refresh()
public void setProperty(int key, java.lang.String value)
key
- int
int value for the key of a specific attributevalue
- String
value for this attributepublic void refreshFooter(java.lang.String valueToBeDisplay)
valueToBeDisplay
- String
value for the text value displayed in the footerpublic void setFooterField(FooterField field)
{@link
- FooterField} footer field to put the text of the textinput into.
This is useful for long text, so it can be displayed in the footer.
null
value if there is no footer.FooterField
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |