|
NextApp Echo2 Extras v2.1.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object nextapp.echo2.app.Component nextapp.echo2.extras.app.TabPane
public class TabPane
A container pane which displays child components in separate tabs.
Field Summary | |
---|---|
static java.lang.String |
ACTIVE_TAB_INDEX_CHANGED_PROPERTY
|
static int |
BORDER_TYPE_ADJACENT_TO_TABS
Constant for the borderType property indicating that a
border should be drawn immediately adjacent to the tabs only. |
static int |
BORDER_TYPE_NONE
Constant for the borderType property indicating that no
border should be drawn around the content. |
static int |
BORDER_TYPE_PARALLEL_TO_TABS
Constant for the borderType property indicating that
borders should be drawn above and below the content, but not at its
sides. |
static int |
BORDER_TYPE_SURROUND
Constant for the borderType property indicating that
borders should be drawn on all sides of the content. |
static java.lang.String |
INPUT_TAB_INDEX
|
static java.lang.String |
PROPERTY_BORDER_TYPE
|
static java.lang.String |
PROPERTY_DEFAULT_CONTENT_INSETS
|
static java.lang.String |
PROPERTY_INSETS
|
static java.lang.String |
PROPERTY_TAB_ACTIVE_BACKGROUND
|
static java.lang.String |
PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE
|
static java.lang.String |
PROPERTY_TAB_ACTIVE_BORDER
|
static java.lang.String |
PROPERTY_TAB_ACTIVE_FONT
|
static java.lang.String |
PROPERTY_TAB_ACTIVE_FOREGROUND
|
static java.lang.String |
PROPERTY_TAB_HEIGHT
|
static java.lang.String |
PROPERTY_TAB_INACTIVE_BACKGROUND
|
static java.lang.String |
PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE
|
static java.lang.String |
PROPERTY_TAB_INACTIVE_BORDER
|
static java.lang.String |
PROPERTY_TAB_INACTIVE_FONT
|
static java.lang.String |
PROPERTY_TAB_INACTIVE_FOREGROUND
|
static java.lang.String |
PROPERTY_TAB_INSET
|
static java.lang.String |
PROPERTY_TAB_POSITION
|
static java.lang.String |
PROPERTY_TAB_SPACING
|
static java.lang.String |
PROPERTY_TAB_WIDTH
|
static int |
TAB_POSITION_BOTTOM
Constant for the tabPosition property indicating that the
tabs should be rendered beneath the content. |
static int |
TAB_POSITION_TOP
Constant for the tabPosition property indicating that the
tabs should be rendered above the content. |
Fields inherited from class nextapp.echo2.app.Component |
---|
CHILDREN_CHANGED_PROPERTY, ENABLED_CHANGED_PROPERTY, FOCUS_TRAVERSAL_INDEX_CHANGED_PROPERTY, FOCUS_TRAVERSAL_PARTICIPANT_CHANGED_PROPERTY, LAYOUT_DIRECTION_CHANGED_PROPERTY, LOCALE_CHANGED_PROPERTY, PROPERTY_BACKGROUND, PROPERTY_FONT, PROPERTY_FOREGROUND, PROPERTY_LAYOUT_DATA, STYLE_CHANGED_PROPERTY, STYLE_NAME_CHANGED_PROPERTY, VISIBLE_CHANGED_PROPERTY |
Constructor Summary | |
---|---|
TabPane()
|
Method Summary | |
---|---|
int |
getActiveTabIndex()
Returns the index of the active tab. |
int |
getBorderType()
Returns the mode in which the border will be drawn around the TabPane . |
nextapp.echo2.app.Insets |
getDefaultContentInsets()
Returns the default content inset margin. |
nextapp.echo2.app.Insets |
getInsets()
Returns the Insets around the entire TabPane . |
nextapp.echo2.app.Color |
getTabActiveBackground()
Returns the background color used to render active tabs. |
nextapp.echo2.app.FillImage |
getTabActiveBackgroundImage()
Returns the background image used to render active tabs. |
nextapp.echo2.app.Border |
getTabActiveBorder()
Returns the Border used to draw the active tab and
surround the content of the TabPane . |
nextapp.echo2.app.Font |
getTabActiveFont()
Returns the font used to render active tabs. |
nextapp.echo2.app.Color |
getTabActiveForeground()
Returns the foreground color used to render active tabs. |
nextapp.echo2.app.Extent |
getTabHeight()
Returns the height of an individual tab. |
nextapp.echo2.app.Color |
getTabInactiveBackground()
Returns the background color used to render inactive tabs. |
nextapp.echo2.app.FillImage |
getTabInactiveBackgroundImage()
Returns the background image used to render inactive tabs. |
nextapp.echo2.app.Border |
getTabInactiveBorder()
Returns the Border used to draw inactive tabs. |
nextapp.echo2.app.Font |
getTabInactiveFont()
Returns the font used to render inactive tabs. |
nextapp.echo2.app.Color |
getTabInactiveForeground()
Returns the foreground color used to render inactive tabs. |
nextapp.echo2.app.Extent |
getTabInset()
Returns the horizontal distance from which all tabs are inset from the edge of the TabPane . |
int |
getTabPosition()
Returns the position where the tabs are located relative to the pane content. |
nextapp.echo2.app.Extent |
getTabSpacing()
Returns the horizontal space between individual tabs. |
nextapp.echo2.app.Extent |
getTabWidth()
Returns the width of an individual tab. |
boolean |
isValidParent(nextapp.echo2.app.Component c)
|
void |
processInput(java.lang.String inputName,
java.lang.Object inputValue)
|
void |
setActiveTabIndex(int newValue)
Sets the active tab index. |
void |
setBorderType(int newValue)
Sets the mode in which the border will be drawn around the TabPane . |
void |
setDefaultContentInsets(nextapp.echo2.app.Insets newValue)
Sets the default content inset margin. |
void |
setInsets(nextapp.echo2.app.Insets newValue)
Sets the Insets around the entire TabPane . |
void |
setTabActiveBackground(nextapp.echo2.app.Color newValue)
Sets the background color used to render active tabs. |
void |
setTabActiveBackgroundImage(nextapp.echo2.app.FillImage newValue)
Sets the background image used to render active tabs. |
void |
setTabActiveBorder(nextapp.echo2.app.Border newValue)
Sets the Border used to draw the active tab and
surround the content of the TabPane . |
void |
setTabActiveFont(nextapp.echo2.app.Font newValue)
Sets the font used to render active tabs. |
void |
setTabActiveForeground(nextapp.echo2.app.Color newValue)
Sets the foreground color used to render active tabs. |
void |
setTabHeight(nextapp.echo2.app.Extent newValue)
Sets the height of an individual tab. |
void |
setTabInactiveBackground(nextapp.echo2.app.Color newValue)
Sets the background color used to render inactive tabs. |
void |
setTabInactiveBackgroundImage(nextapp.echo2.app.FillImage newValue)
Sets the background image used to render inactive tabs. |
void |
setTabInactiveBorder(nextapp.echo2.app.Border newValue)
Sets the Border used to draw inactive tabs in the
TabPane . |
void |
setTabInactiveFont(nextapp.echo2.app.Font newValue)
Sets the font used to render inactive tabs. |
void |
setTabInactiveForeground(nextapp.echo2.app.Color newValue)
Sets the foreground color used to render inactive tabs. |
void |
setTabInset(nextapp.echo2.app.Extent newValue)
Sets the horizontal distance from which all tabs are inset from the edge of the TabPane . |
void |
setTabPosition(int newValue)
Sets the position where the tabs are located relative to the pane content. |
void |
setTabSpacing(nextapp.echo2.app.Extent newValue)
Sets the horizontal space between individual tabs. |
void |
setTabWidth(nextapp.echo2.app.Extent newValue)
Sets the width of an individual tab. |
Methods inherited from class nextapp.echo2.app.Component |
---|
add, add, addPropertyChangeListener, addPropertyChangeListener, dispose, firePropertyChange, getApplicationInstance, getBackground, getComponent, getComponent, getComponentCount, getComponents, getEventListenerList, getFocusTraversalIndex, getFont, getForeground, getId, getIndexedProperty, getLayoutData, getLayoutDirection, getLocale, getParent, getProperty, getRenderId, getRenderIndexedProperty, getRenderIndexedProperty, getRenderLayoutDirection, getRenderLocale, getRenderProperty, getRenderProperty, getStyle, getStyleName, getVisibleComponent, getVisibleComponentCount, getVisibleComponents, hasEventListenerList, indexOf, init, isAncestorOf, isEnabled, isFocusTraversalParticipant, isRegistered, isRenderEnabled, isRenderVisible, isValidChild, isVisible, remove, remove, removeAll, removePropertyChangeListener, removePropertyChangeListener, setBackground, setEnabled, setFocusTraversalIndex, setFocusTraversalParticipant, setFont, setForeground, setId, setIndexedProperty, setLayoutData, setLayoutDirection, setLocale, setProperty, setRenderId, setStyle, setStyleName, setVisible, validate, verifyInput, visibleIndexOf |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String INPUT_TAB_INDEX
public static final java.lang.String ACTIVE_TAB_INDEX_CHANGED_PROPERTY
public static final java.lang.String PROPERTY_BORDER_TYPE
public static final java.lang.String PROPERTY_DEFAULT_CONTENT_INSETS
public static final java.lang.String PROPERTY_INSETS
public static final java.lang.String PROPERTY_TAB_ACTIVE_BACKGROUND
public static final java.lang.String PROPERTY_TAB_ACTIVE_BACKGROUND_IMAGE
public static final java.lang.String PROPERTY_TAB_ACTIVE_BORDER
public static final java.lang.String PROPERTY_TAB_ACTIVE_FONT
public static final java.lang.String PROPERTY_TAB_ACTIVE_FOREGROUND
public static final java.lang.String PROPERTY_TAB_HEIGHT
public static final java.lang.String PROPERTY_TAB_INACTIVE_BACKGROUND
public static final java.lang.String PROPERTY_TAB_INACTIVE_BACKGROUND_IMAGE
public static final java.lang.String PROPERTY_TAB_INACTIVE_BORDER
public static final java.lang.String PROPERTY_TAB_INACTIVE_FONT
public static final java.lang.String PROPERTY_TAB_INACTIVE_FOREGROUND
public static final java.lang.String PROPERTY_TAB_INSET
public static final java.lang.String PROPERTY_TAB_SPACING
public static final java.lang.String PROPERTY_TAB_POSITION
public static final java.lang.String PROPERTY_TAB_WIDTH
public static final int BORDER_TYPE_NONE
borderType
property indicating that no
border should be drawn around the content.
public static final int BORDER_TYPE_ADJACENT_TO_TABS
borderType
property indicating that a
border should be drawn immediately adjacent to the tabs only.
If the tabs are positioned at the top of the TabPane
the
border will only be drawn directly beneath the tabs with this setting.
If the tabs are positioned at the bottom of the TabPane
the
border will only be drawn directly above the tabs with this setting.
This is the default rendering style.
public static final int BORDER_TYPE_PARALLEL_TO_TABS
borderType
property indicating that
borders should be drawn above and below the content, but not at its
sides.
public static final int BORDER_TYPE_SURROUND
borderType
property indicating that
borders should be drawn on all sides of the content.
public static final int TAB_POSITION_BOTTOM
tabPosition
property indicating that the
tabs should be rendered beneath the content.
public static final int TAB_POSITION_TOP
tabPosition
property indicating that the
tabs should be rendered above the content.
This is the default rendering style.
Constructor Detail |
---|
public TabPane()
Method Detail |
---|
public int getActiveTabIndex()
public int getBorderType()
TabPane
.
BORDER_TYPE_NONE
BORDER_TYPE_ADJACENT_TO_TABS
(the default)BORDER_TYPE_PARALLEL_TO_TABS
BORDER_TYPE_SURROUND
public nextapp.echo2.app.Insets getDefaultContentInsets()
public nextapp.echo2.app.Insets getInsets()
Insets
around the entire TabPane
.
Insets will only be drawn on sides of the TabPane
which have
a border (i.e., based on the value of the borderType
property).
Values for this property must be in pixel units.
public nextapp.echo2.app.Color getTabActiveBackground()
public nextapp.echo2.app.FillImage getTabActiveBackgroundImage()
public nextapp.echo2.app.Border getTabActiveBorder()
Border
used to draw the active tab and
surround the content of the TabPane
.
public nextapp.echo2.app.Font getTabActiveFont()
public nextapp.echo2.app.Color getTabActiveForeground()
public nextapp.echo2.app.Extent getTabHeight()
Extent
values for this property must be in pixel units.
public nextapp.echo2.app.Color getTabInactiveBackground()
public nextapp.echo2.app.FillImage getTabInactiveBackgroundImage()
public nextapp.echo2.app.Border getTabInactiveBorder()
Border
used to draw inactive tabs.
public nextapp.echo2.app.Font getTabInactiveFont()
public nextapp.echo2.app.Color getTabInactiveForeground()
public nextapp.echo2.app.Extent getTabInset()
TabPane
.
public int getTabPosition()
TAB_POSITION_TOP
TAB_POSITION_BOTTOM
public nextapp.echo2.app.Extent getTabSpacing()
public nextapp.echo2.app.Extent getTabWidth()
public boolean isValidParent(nextapp.echo2.app.Component c)
isValidParent
in class nextapp.echo2.app.Component
Component.isValidParent(nextapp.echo2.app.Component)
public void processInput(java.lang.String inputName, java.lang.Object inputValue)
processInput
in class nextapp.echo2.app.Component
Component.processInput(java.lang.String, java.lang.Object)
public void setActiveTabIndex(int newValue)
newValue
- the index of the child Component
whose tab
should be displayedpublic void setBorderType(int newValue)
TabPane
.
newValue
- the new border type one of the following values:
BORDER_TYPE_NONE
BORDER_TYPE_ADJACENT_TO_TABS
(the default)BORDER_TYPE_PARALLEL_TO_TABS
BORDER_TYPE_SURROUND
public void setDefaultContentInsets(nextapp.echo2.app.Insets newValue)
newValue
- the new default content inset marginpublic void setInsets(nextapp.echo2.app.Insets newValue)
Insets
around the entire TabPane
.
Insets will only be drawn on sides of the TabPane
which have
a border (i.e., based on the value of the borderType
property).
Values for this property must be in pixel units.
newValue
- the new inset marginpublic void setTabActiveBackground(nextapp.echo2.app.Color newValue)
newValue
- the new active tab backgroundpublic void setTabActiveBackgroundImage(nextapp.echo2.app.FillImage newValue)
newValue
- the new active tab background imagepublic void setTabActiveBorder(nextapp.echo2.app.Border newValue)
Border
used to draw the active tab and
surround the content of the TabPane
.
newValue
- the new borderpublic void setTabActiveFont(nextapp.echo2.app.Font newValue)
newValue
- the new active tab fontpublic void setTabActiveForeground(nextapp.echo2.app.Color newValue)
newValue
- the new active tab foregroundpublic void setTabHeight(nextapp.echo2.app.Extent newValue)
Extent
values for this property must be in pixel units.
newValue
- the new tab heightpublic void setTabInactiveBackground(nextapp.echo2.app.Color newValue)
newValue
- the new inactive tab backgroundpublic void setTabInactiveBackgroundImage(nextapp.echo2.app.FillImage newValue)
newValue
- the new inactive tab background imagepublic void setTabInactiveBorder(nextapp.echo2.app.Border newValue)
Border
used to draw inactive tabs in the
TabPane
.
newValue
- the new borderpublic void setTabInactiveFont(nextapp.echo2.app.Font newValue)
newValue
- the new inactive tab fontpublic void setTabInactiveForeground(nextapp.echo2.app.Color newValue)
newValue
- the new inactive tab foregroundpublic void setTabInset(nextapp.echo2.app.Extent newValue)
TabPane
.
newValue
- the new tab insetpublic void setTabPosition(int newValue)
newValue
- the new tab position, one of the following values:
TAB_POSITION_TOP
TAB_POSITION_BOTTOM
public void setTabSpacing(nextapp.echo2.app.Extent newValue)
newValue
- the new tab spacingpublic void setTabWidth(nextapp.echo2.app.Extent newValue)
newValue
- the new tab width
|
NextApp Echo2 Extras v2.1.0 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |