|
|||||||||
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.LabelField
com.sybase.uep.bobclient.controls.HyperLink
public class HyperLink
This is the hyper link control
Field Summary |
---|
Fields inherited from class net.rim.device.api.ui.component.LabelField |
---|
DEFAULT_POSITION |
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 | |
---|---|
HyperLink(int labelRID,
long style)
HyperLink constructor |
|
HyperLink(int labelRID,
long style,
boolean showBackgroundColor)
HyperLink constructor |
|
HyperLink(java.lang.String label,
long style)
HyperLink constructor |
|
HyperLink(java.lang.String label,
long style,
boolean showBackgroundColor)
HyperLink 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) |
int |
getControlID()
Returns the control's ID |
ICustomEventsDelegate |
getCustomEventsDelegate()
Returns the control's custom events delegate |
FontStyle |
getFocusFontStyle()
Retrieve focus font style |
long |
getHorizontalAlignment()
(non-Javadoc) |
int |
getHyperLinkWidth()
Retrieve hyperlink width |
LogicalType |
getLogicalType()
Retrieve the logical type assign to this control |
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 boolean |
navigationClick(int status,
int time)
(non-Javadoc) |
protected boolean |
navigationMovement(int dx,
int dy,
int status,
int time)
(non-Javadoc) |
protected boolean |
navigationUnclick(int status,
int time)
(non-Javadoc) |
protected void |
onFocus(int direction)
(non-Javadoc) |
protected void |
onUnfocus()
(non-Javadoc) |
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 |
setControlID(int controlID)
Sets the control's ID |
void |
setCustomEventsDelegate(ICustomEventsDelegate delegate,
int eventsFlags)
Sets the control's custom events delegate for the given events |
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 |
setLogicalType(LogicalType logicalType)
Set logical type |
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.Object text)
Set the label value |
void |
setUnfocusFontStyle(FontStyle fontStyle)
Set the unfocus font style for this control |
void |
setValue(java.lang.String value)
Set the value for this hyperlink |
void |
setVariableLabel(ControlVariable variable)
Set the control variable object for the label |
void |
setVariableValue(ControlVariable variable)
Set the control variable object for the value |
protected boolean |
touchEvent(net.rim.device.api.ui.TouchEvent message)
(non-Javadoc) |
Methods inherited from class net.rim.device.api.ui.component.LabelField |
---|
getAccessibleContext, getPosition, getText, isSelectionCopyable, selectionCopy, setPosition, setText, setText, setText, toString |
Methods inherited from class net.rim.device.api.ui.Field |
---|
drawHighlightRegion, fieldChangeNotify, focusAdd, focusChangeNotify, focusRemove, getBackground, getBackground, getBorder, getBorder, getBorder, getChangeListener, getContentHeight, getContentLeft, getContentRect, getContentRect, getContentTop, getContentWidth, getContextMenu, getContextMenu, getCookie, getExtent, getExtent, getFieldStyle, getFocusListener, getFocusRect, 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, invokeAction, isDataValid, isDirty, isEditable, isFocus, isFocusable, isMuddy, isPasteable, isSelectable, isSelecting, isSelectionCutable, isSelectionDeleteable, isSpellCheckable, isStyle, isVisible, keyChar, keyControl, keyDown, keyRepeat, keyStatus, keyUp, makeContextMenu, moveFocus, moveFocus, onDisplay, onExposed, onMenuDismissed, onMenuDismissed, onObscured, onUndisplay, onVisibilityChange, paintBackground, paste, select, selectionCut, selectionDelete, setBackground, setBackground, setBorder, setBorder, setBorder, setBorder, setBorder, setChangeListener, setCookie, setDirty, setEditable, setExtent, setFocus, setFocusListener, setFont, setFont, setMargin, setMargin, setMuddy, setNonSpellCheckable, setPadding, setPadding, setPosition, setVisualState, trackwheelClick, trackwheelUnclick, updateLayout |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public HyperLink(int labelRID, long style)
labelRID
- int
value for the localization resource ID of the label to be displayedstyle
- String
value for the style of this control
eg. Field.FIELD_LEFT
, Field.FIELD_RIGHT
, Field.FIELD_HCENTER
, etc.Field
public HyperLink(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 HyperLink(int labelRID, long style, boolean showBackgroundColor)
labelRID
- int
value for the localization resource ID of the label to be displayedstyle
- String
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 HyperLink(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.Field
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 void setVariableValue(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 void setValue(java.lang.String value)
value
- String
new valuepublic java.lang.Object getValue()
getValue
in interface Control
Object
of the value set for this controlControl.getValue()
public void setLogicalType(LogicalType logicalType)
logicalType
- LogicalType
logical type objectLogicalType
public LogicalType getLogicalType()
LogicalType
logical type objectLogicalType
public IBOBAction getAction()
IBOBAction
action objectIBOBAction
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.Object text)
setText
in class net.rim.device.api.ui.component.LabelField
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.LabelField
int
value of the available layout widthControl.getPreferredWidth()
public int getHyperLinkWidth()
int
value for the width of the link textpublic int getPreferredHeight()
getPreferredHeight
in interface Control
getPreferredHeight
in class net.rim.device.api.ui.component.LabelField
int
value of the available layout heightControl.getPreferredHeight()
protected void layout(int width, int height)
layout
in class net.rim.device.api.ui.component.LabelField
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.Field
Field.drawFocus(Graphics g, boolean on)
protected void onFocus(int direction)
onFocus
in class net.rim.device.api.ui.Field
Field.onFocus(int direction)
protected void onUnfocus()
onUnfocus
in class net.rim.device.api.ui.Field
Field.onUnfocus()
protected boolean navigationClick(int status, int time)
navigationClick
in class net.rim.device.api.ui.Field
Field.navigationClick(int status, int time)
protected boolean navigationUnclick(int status, int time)
navigationUnclick
in class net.rim.device.api.ui.Field
Field.navigationUnclick(int status, int time)
protected boolean navigationMovement(int dx, int dy, int status, int time)
navigationMovement
in class net.rim.device.api.ui.Field
Field.navigationMovement(int dx, int dy, int status, int time)
protected boolean touchEvent(net.rim.device.api.ui.TouchEvent message)
touchEvent
in class net.rim.device.api.ui.Field
Field.touchEvent(TouchEvent message)
protected void paint(net.rim.device.api.ui.Graphics g)
paint
in class net.rim.device.api.ui.component.LabelField
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 to be display 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
public ICustomEventsDelegate getCustomEventsDelegate()
public void setCustomEventsDelegate(ICustomEventsDelegate delegate, int eventsFlags)
delegate
- custom events delegateeventsFlags
- the events to set delegate topublic int getControlID()
public void setControlID(int controlID)
controlId
- control ID
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |