com.guiseframework.model.ui
Interface PresentationModel

All Superinterfaces:

Displayable, Model, com.globalmentor.beans.PropertyBindable, com.globalmentor.beans.PropertyConstrainable

All Known Subinterfaces:

ActionControl, ActionValueControl<V>, ApplicationFrame, ArrangeContainer, Box, ButtonControl, CardContainer, CardControl, Component, CompositeComponent, Container, ContainerControl, ContentComponent, Control, DialogFrame<V>, EditComponent, FlyoverFrame, Frame, HeadingComponent, ImageComponent, InputFocusableComponent, InputFocusGroupComponent, LabelComponent, LabelDisplayableComponent, LayoutComponent, LayoutControl, LinkControl, ListSelectControl<V>, Menu, ModalComponent<M>, ModalFrame<R>, ModalNavigationPanel<R>, OptionDialogFrame<O>, Panel, PendingImageComponent, SelectActionControl, SelectButtonControl, SelectControl<V>, SelectLinkControl, ToolButtonControl, URFResourceAlterationComponent, ValueControl<V>, ValuedComponent<V>, Widget

All Known Implementing Classes:

AboutPanel, AbstractActionControl, AbstractActionValueControl, AbstractApplicationFrame, AbstractArrayCompositeComponent, AbstractBooleanSelectActionControl, AbstractBox, AbstractButtonControl, AbstractCardPanel, AbstractComponent, AbstractCompositeComponent, AbstractCompositeStateComponent, AbstractCompositeStateControl, AbstractContainer, AbstractContainerControl, AbstractContainerValueControl, AbstractControl, AbstractDialogFrame, AbstractEditComponentTextControl, AbstractEditValueControl, AbstractEditValuePanel, AbstractEnumCompositeComponent, AbstractFlyoverFrame, AbstractFrame, AbstractImageComponent, AbstractLabel, AbstractLayoutComponent, AbstractLayoutControl, AbstractLayoutValueControl, AbstractLinkControl, AbstractListCompositeComponent, AbstractListSelectContainerControl, AbstractListSelectControl, AbstractMenu, AbstractModalFrame, AbstractModalNavigationPanel, AbstractMultipleCompositeComponent, AbstractOptionDialogFrame, AbstractPanel, AbstractPresentationModel, AbstractSelectActionControl, AbstractSelectActionValueControl, AbstractSequenceTaskPanel, AbstractSingleCompositeComponent, AbstractTextControl, AbstractValueControl, AbstractValuedPanel, AccordionMenu, ArrangePanel, AuthorizeUsersPanel, AutoNavigationPathBreadcrumbLinkPanel, BookDescriptionPanel, BookmarksPanel, BooleanSelectButton, BooleanSelectLink, BooleanSelectToolButton, BooleanValueControlSelectControl, BusyPanel, Button, CalendarControl, CalendarDialogFrame, CalendarsPanel, CardPanel, CardTabControl, CheckControl, DateTimeControl, DateTimeFieldsControl, DefaultApplicationFrame, DefaultDialogFrame, DefaultFlyoverFrame, DefaultFrame, DefaultModalFrame, DefaultModalNavigationPanel, DiagnosticPanel, DropDetailsPanel, DropMenu, EditComponentLabelControl, EditComponentTextControl, EditUserPanel, EditUsersPanel, EventWizardPanel, EventWizardPanel.BusinessAddressPanel, EventWizardPanel.BusinessNamePanel, EventWizardPanel.EventNamePanel, EventWizardPanel.PersonalAgePanel, EventWizardPanel.PersonalEmailPanel, EventWizardPanel.PersonalNamePanel, EventWizardPanel2, Flash, GenerateContentPanel, GroupPanel, Heading, HeadingLink, HelloUserPanel, HelloWorldPanel, HomePanel, HomePanel.TestFrame, Image, ImageActionControl, ImageBooleanSelectActionControl, ImageOpacityPanel, InternationalizationPanel, Label, LayoutPanel, Link, ListControl, LoginPanel, MarmotPanel, MenusPanel, Message, MessageOptionDialogFrame, MultiplicationTablePanel, NamePanel, NavigationPathBreadcrumbLinkPanel, NotificationOptionDialogFrame, PasswordAuthenticationPanel, PendingImage, PendingImageActionControl, Picture, PlatformFileUploadPanel, ResourceCollectControl, ResourceImportControl, RestrictedPanel, RichTextEditPanel, ScrollControl, SectionPanel, SelectableLabel, SelectButton, SelectLink, SequenceCardPanel, SliderControl, SpinnerControl, TabbedPanel, TabContainerControl, TabControl, Table, Table.ColumnUIModel, Table.DefaultCellMessage, TabsPanel, TaskStateSelectLink, TemperatureConversionPanel, TemperatureConversionPanel2, TextBox, TextControl, TextSearchPanel, Toolbar, ToolButton, TreeControl, URFProcessPanel, ValueSelectButton, ValueSelectLink

public interface PresentationModel
extends Model, Displayable

Encapsulation of presentation-related information.

Author:

Garret Wilson

Field Summary

static java.lang.String	BACKGROUND_COLOR_PROPERTY The bound property of the background color.
static java.lang.String	BORDER_LINE_FAR_COLOR_PROPERTY The bound property of the line far border color.
static java.lang.String	BORDER_LINE_FAR_EXTENT_PROPERTY The bound property of the line far border extent.
static java.lang.String	BORDER_LINE_FAR_STYLE_PROPERTY The bound property of the line far border style.
static java.lang.String	BORDER_LINE_NEAR_COLOR_PROPERTY The bound property of the line near border color.
static java.lang.String	BORDER_LINE_NEAR_EXTENT_PROPERTY The bound property of the line near border extent.
static java.lang.String	BORDER_LINE_NEAR_STYLE_PROPERTY The bound property of the line near border style.
static java.lang.String	BORDER_PAGE_FAR_COLOR_PROPERTY The bound property of the page far border color.
static java.lang.String	BORDER_PAGE_FAR_EXTENT_PROPERTY The bound property of the page far border extent.
static java.lang.String	BORDER_PAGE_FAR_STYLE_PROPERTY The bound property of the page far border style.
static java.lang.String	BORDER_PAGE_NEAR_COLOR_PROPERTY The bound property of the page near border color.
static java.lang.String	BORDER_PAGE_NEAR_EXTENT_PROPERTY The bound property of the page near border extent.
static java.lang.String	BORDER_PAGE_NEAR_STYLE_PROPERTY The bound property of the page near border style.
static java.lang.String	CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY The bound property of the line far page far corner arc size.
static java.lang.String	CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY The bound property of the line far page near corner arc size.
static java.lang.String	CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY The bound property of the line near page far corner arc size.
static java.lang.String	CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY The bound property of the line near page near corner arc size.
static java.lang.String	CURSOR_PROPERTY The bound property of the cursor.
static java.lang.String	FONT_FAMILIES_PROPERTY The bound property of the font families.
static java.lang.String	FONT_SIZE_PROPERTY The bound property of the font size.
static java.lang.String	FONT_STYLE_PROPERTY The bound property of the font style.
static double	FONT_WEIGHT_BOLD The bold font weight.
static double	FONT_WEIGHT_NORMAL The normal font weight.
static java.lang.String	FONT_WEIGHT_PROPERTY The bound property of the font weight.
static java.lang.String	LABEL_FONT_FAMILIES_PROPERTY The bound property of the label font families.
static java.lang.String	LABEL_FONT_SIZE_PROPERTY The bound property of the label font size.
static java.lang.String	LABEL_FONT_STYLE_PROPERTY The bound property of the label font style.
static java.lang.String	LABEL_FONT_WEIGHT_PROPERTY The bound property of the label font weight.
static java.lang.String	LABEL_TEXT_COLOR_PROPERTY The bound property of the label text color.
static java.lang.String	LINE_EXTENT_PROPERTY The line extent (width in left-to-right top-to-bottom orientation) bound property.
static java.lang.String	MARGIN_LINE_FAR_EXTENT_PROPERTY The bound property of the line far margin extent.
static java.lang.String	MARGIN_LINE_NEAR_EXTENT_PROPERTY The bound property of the line near margin extent.
static java.lang.String	MARGIN_PAGE_FAR_EXTENT_PROPERTY The bound property of the page far margin extent.
static java.lang.String	MARGIN_PAGE_NEAR_EXTENT_PROPERTY The bound property of the page near margin extent.
static java.lang.String	OPACITY_PROPERTY The opacity bound property.
static java.lang.String	PADDING_LINE_FAR_EXTENT_PROPERTY The bound property of the line far padding extent.
static java.lang.String	PADDING_LINE_NEAR_EXTENT_PROPERTY The bound property of the line near padding extent.
static java.lang.String	PADDING_PAGE_FAR_EXTENT_PROPERTY The bound property of the page far padding extent.
static java.lang.String	PADDING_PAGE_NEAR_EXTENT_PROPERTY The bound property of the page near padding extent.
static java.lang.String	PAGE_EXTENT_PROPERTY The page extent (height in left-to-right top-to-bottom orientation) bound property.
static Dimensions	ROUNDED_CORNER_ARC_SIZE
static java.lang.String	STYLE_ID_PROPERTY The bound property of the component style ID.
static java.lang.String	TEXT_COLOR_PROPERTY The bound property of the text color.
static java.lang.String	TOOLTIP_ENABLED_PROPERTY The bound property of whether the component has tooltips enabled.
static java.lang.String	VISIBLE_PROPERTY The bound property of whether the component is visible.

Fields inherited from interface com.guiseframework.model.Model

PLAIN_TEXT_CONTENT_TYPE, XHTML_CONTENT_TYPE, XHTML_FRAGMENT_CONTENT_TYPE

Fields inherited from interface com.guiseframework.model.Displayable

DISPLAYED_PROPERTY

Method Summary

Color	BorderLineFarColor() Returns the border color of the line far page near border.
Extent	BorderLineFarExtent() Returns the border extent of the line far page near border.
LineStyle	BorderLineFarStyle() Returns the border style of the line far page near border.
Color	BorderLineNearColor() Returns the border color of the line near page near border.
Extent	BorderLineNearExtent() Returns the border extent of the line near page near border.
LineStyle	BorderLineNearStyle() Returns the border style of the line near page near border.
Color	BorderPageFarColor() Returns the border color of the line far page far border.
Extent	BorderPageFarExtent() Returns the border extent of the line far page far border.
LineStyle	BorderPageFarStyle() Returns the border style of the line far page far border.
Color	BorderPageNearColor() Returns the border color of the line near page far border.
Extent	BorderPageNearExtent() Returns the border extent of the line near page far border.
LineStyle	BorderPageNearStyle() Returns the border style of the line near page far border.
Color	getBackgroundColor()
Color	getBorderColor(Border border) Returns the border color of the indicated border.
Extent	getBorderExtent(Border border) Returns the border extent of the indicated border.
LineStyle	getBorderStyle(Border border) Returns the border style of the indicated border.
Dimensions	getCornerArcSize(Corner corner) Returns the arc size for the indicated corner.
Dimensions	getCornerLineFarPageFarArcSize() Returns the arc size for the line far page far corner.
Dimensions	getCornerLineFarPageNearArcSize() Returns the arc size for the line far page near corner.
Dimensions	getCornerLineNearPageFarArcSize() Returns the arc size for the line near page far corner.
Dimensions	getCornerLineNearPageNearArcSize() Returns the arc size for the line near page near corner.
java.net.URI	getCursor()
Extent	getExtent(Flow flow) Returns the extent of the indicated flow.
java.util.List<java.lang.String>	getFontFamilies()
Extent	getFontSize()
FontStyle	getFontStyle()
double	getFontWeight()
java.util.List<java.lang.String>	getLabelFontFamilies()
Extent	getLabelFontSize()
FontStyle	getLabelFontStyle()
double	getLabelFontWeight()
Color	getLabelTextColor()
Extent	getLineExtent() Returns the extent of the line flow.
Extent	getMarginExtent(Border border) Returns the margin extent of the indicated border.
Extent	getMarginLineFarExtent() Returns the margin extent of the line far page near border.
Extent	getMarginLineNearExtent() Returns the margin extent of the line near page near border.
Extent	getMarginPageFarExtent() Returns the margin extent of the line far page far border.
Extent	getMarginPageNearExtent() Returns the margin extent of the line near page far border.
double	getOpacity()
Extent	getPaddingExtent(Border border) Returns the padding extent of the indicated border.
Extent	getPaddingLineFarExtent() Returns the padding extent of the line far page near border.
Extent	getPaddingLineNearExtent() Returns the padding extent of the line near page near border.
Extent	getPaddingPageFarExtent() Returns the padding extent of the line far page far border.
Extent	getPaddingPageNearExtent() Returns the padding extent of the line near page far border.
Extent	getPageExtent() Returns the extent of the page flow.
GuiseSession	getSession()
java.lang.String	getStyleID()
Color	getTextColor()
boolean	isDisplayed()
boolean	isTooltipEnabled()
boolean	isVisible()
void	setBackgroundColor(Color newBackgroundColor) Sets the background color of the component.
void	setBorderColor(Border border, Color newBorderColor) Sets the border color of a given border.
void	setBorderColor(Color newBorderColor) Sets the border color of all borders.
void	setBorderExtent(Border border, Extent newBorderExtent) Sets the border extent of a given border.
void	setBorderExtent(Extent newBorderExtent) Sets the border extent of all borders.
void	setBorderLineFarColor(Color newBorderColor) Sets the border color of the line far border.
void	setBorderLineFarExtent(Extent newBorderExtent) Sets the border extent of the line far border.
void	setBorderLineFarStyle(LineStyle newBorderStyle) Sets the border style of the line far border.
void	setBorderLineNearColor(Color newBorderColor) Sets the border COLOR of the line near border.
void	setBorderLineNearExtent(Extent newBorderExtent) Sets the border extent of the line near border.
void	setBorderLineNearStyle(LineStyle newBorderStyle) Sets the border style of the line near border.
void	setBorderPageFarColor(Color newBorderColor) Sets the border color of the page far border.
void	setBorderPageFarExtent(Extent newBorderExtent) Sets the border extent of the page far border.
void	setBorderPageFarStyle(LineStyle newBorderStyle) Sets the border style of the page far border.
void	setBorderPageNearColor(Color newBorderColor) Sets the border color of the page near border.
void	setBorderPageNearExtent(Extent newBorderExtent) Sets the border extent of the page near border.
void	setBorderPageNearStyle(LineStyle newBorderStyle) Sets the border style of the page near border.
void	setBorderStyle(Border border, LineStyle newBorderStyle) Sets the border style of a given border.
void	setBorderStyle(LineStyle newBorderStyle) Sets the border style of all borders.
void	setCornerArcSize(Corner corner, Dimensions newCornerArcSize) Sets the arc size of a given corner.
void	setCornerArcSize(Dimensions newCornerArcSize) Sets the arc size of all corners.
void	setCornerLineFarPageFarArcSize(Dimensions newCornerArcSize) Sets the arc size of the line far page far corner.
void	setCornerLineFarPageNearArcSize(Dimensions newCornerArcSize) Sets the arc size of the line far page near corner.
void	setCornerLineNearPageFarArcSize(Dimensions newCornerArcSize) Sets the arc size of the line near page far corner.
void	setCornerLineNearPageNearArcSize(Dimensions newCornerArcSize) Sets the arc size of the line near page near corner.
void	setCursor(java.net.URI newCursor) Sets the URI of the cursor.
void	setDisplayed(boolean newDisplayed) Sets whether the component is displayed or has no representation, taking up no space.
void	setExtent(Flow flow, Extent newExtent) Sets the extent of a given flow.
void	setFontFamilies(java.util.List<java.lang.String> newFontFamilies) Sets the font families of the component.
void	setFontSize(Extent newFontSize) Sets the font size of the component.
void	setFontStyle(FontStyle newFontStyle) Sets the style of the font.
void	setFontWeight(double newFontWeight) Sets the weight of the font.
void	setLabelFontFamilies(java.util.List<java.lang.String> newLabelFontFamilies) Sets the font families of the label.
void	setLabelFontSize(Extent newLabelFontSize) Sets the label font size of the component.
void	setLabelFontStyle(FontStyle newLabelFontStyle) Sets the style of the label font.
void	setLabelFontWeight(double newLabelFontWeight) Sets the weight of the label font.
void	setLabelTextColor(Color newLabelTextColor) Sets the text color of the label.
void	setLineExtent(Extent newExtent) Sets the extent of the line flow.
void	setMarginExtent(Border border, Extent newMarginExtent) Sets the margin extent of a given border.
void	setMarginExtent(Extent newMarginExtent) Sets the margin extent of all borders.
void	setMarginLineFarExtent(Extent newMarginExtent) Sets the margin extent of the line far border.
void	setMarginLineNearExtent(Extent newMarginExtent) Sets the margin extent of the line near border.
void	setMarginPageFarExtent(Extent newMarginExtent) Sets the margin extent of the page far border.
void	setMarginPageNearExtent(Extent newMarginExtent) Sets the margin extent of the page near border.
void	setOpacity(double newOpacity) Sets the opacity of the entire component.
void	setPaddingExtent(Border border, Extent newPaddingExtent) Sets the padding extent of a given border.
void	setPaddingExtent(Extent newPaddingExtent) Sets the padding extent of all borders.
void	setPaddingLineFarExtent(Extent newPaddingExtent) Sets the padding extent of the line far border.
void	setPaddingLineNearExtent(Extent newPaddingExtent) Sets the padding extent of the line near border.
void	setPaddingPageFarExtent(Extent newPaddingExtent) Sets the padding extent of the page far border.
void	setPaddingPageNearExtent(Extent newPaddingExtent) Sets the padding extent of the page near border.
void	setPageExtent(Extent newExtent) Sets the extent of the page flow.
void	setStyleID(java.lang.String newStyleID) Identifies the style for the component.
void	setTextColor(Color newTextColor) Sets the text color of the component.
void	setTooltipEnabled(boolean newTooltipEnabled) Sets whether tooltips are enabled for this component.
void	setVisible(boolean newVisible) Sets whether the component is visible.

Methods inherited from interface com.globalmentor.beans.PropertyBindable

addPropertyChangeListener, addPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, hasPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener

Methods inherited from interface com.globalmentor.beans.PropertyConstrainable

addVetoableChangeListener, addVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, hasVetoableChangeListeners, removeVetoableChangeListener, removeVetoableChangeListener

Field Detail

BACKGROUND_COLOR_PROPERTY

static final java.lang.String BACKGROUND_COLOR_PROPERTY

The bound property of the background color.

BORDER_LINE_NEAR_COLOR_PROPERTY

static final java.lang.String BORDER_LINE_NEAR_COLOR_PROPERTY

The bound property of the line near border color.

BORDER_LINE_FAR_COLOR_PROPERTY

static final java.lang.String BORDER_LINE_FAR_COLOR_PROPERTY

The bound property of the line far border color.

BORDER_PAGE_NEAR_COLOR_PROPERTY

static final java.lang.String BORDER_PAGE_NEAR_COLOR_PROPERTY

The bound property of the page near border color.

BORDER_PAGE_FAR_COLOR_PROPERTY

static final java.lang.String BORDER_PAGE_FAR_COLOR_PROPERTY

The bound property of the page far border color.

BORDER_LINE_NEAR_EXTENT_PROPERTY

static final java.lang.String BORDER_LINE_NEAR_EXTENT_PROPERTY

The bound property of the line near border extent.

BORDER_LINE_FAR_EXTENT_PROPERTY

static final java.lang.String BORDER_LINE_FAR_EXTENT_PROPERTY

The bound property of the line far border extent.

BORDER_PAGE_NEAR_EXTENT_PROPERTY

static final java.lang.String BORDER_PAGE_NEAR_EXTENT_PROPERTY

The bound property of the page near border extent.

BORDER_PAGE_FAR_EXTENT_PROPERTY

static final java.lang.String BORDER_PAGE_FAR_EXTENT_PROPERTY

The bound property of the page far border extent.

BORDER_LINE_NEAR_STYLE_PROPERTY

static final java.lang.String BORDER_LINE_NEAR_STYLE_PROPERTY

The bound property of the line near border style.

BORDER_LINE_FAR_STYLE_PROPERTY

static final java.lang.String BORDER_LINE_FAR_STYLE_PROPERTY

The bound property of the line far border style.

BORDER_PAGE_NEAR_STYLE_PROPERTY

static final java.lang.String BORDER_PAGE_NEAR_STYLE_PROPERTY

The bound property of the page near border style.

BORDER_PAGE_FAR_STYLE_PROPERTY

static final java.lang.String BORDER_PAGE_FAR_STYLE_PROPERTY

The bound property of the page far border style.

CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY

static final java.lang.String CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY

The bound property of the line near page near corner arc size.

CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY

static final java.lang.String CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY

The bound property of the line far page near corner arc size.

CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY

static final java.lang.String CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY

The bound property of the line near page far corner arc size.

CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

static final java.lang.String CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

The bound property of the line far page far corner arc size.

CURSOR_PROPERTY

static final java.lang.String CURSOR_PROPERTY

The bound property of the cursor.

LINE_EXTENT_PROPERTY

static final java.lang.String LINE_EXTENT_PROPERTY

The line extent (width in left-to-right top-to-bottom orientation) bound property.

PAGE_EXTENT_PROPERTY

static final java.lang.String PAGE_EXTENT_PROPERTY

The page extent (height in left-to-right top-to-bottom orientation) bound property.

FONT_FAMILIES_PROPERTY

static final java.lang.String FONT_FAMILIES_PROPERTY

The bound property of the font families.

FONT_SIZE_PROPERTY

static final java.lang.String FONT_SIZE_PROPERTY

The bound property of the font size.

FONT_STYLE_PROPERTY

static final java.lang.String FONT_STYLE_PROPERTY

The bound property of the font style.

FONT_WEIGHT_PROPERTY

static final java.lang.String FONT_WEIGHT_PROPERTY

The bound property of the font weight.

LABEL_FONT_FAMILIES_PROPERTY

static final java.lang.String LABEL_FONT_FAMILIES_PROPERTY

The bound property of the label font families.

LABEL_FONT_SIZE_PROPERTY

static final java.lang.String LABEL_FONT_SIZE_PROPERTY

The bound property of the label font size.

LABEL_FONT_STYLE_PROPERTY

static final java.lang.String LABEL_FONT_STYLE_PROPERTY

The bound property of the label font style.

LABEL_FONT_WEIGHT_PROPERTY

static final java.lang.String LABEL_FONT_WEIGHT_PROPERTY

The bound property of the label font weight.

LABEL_TEXT_COLOR_PROPERTY

static final java.lang.String LABEL_TEXT_COLOR_PROPERTY

The bound property of the label text color.

MARGIN_LINE_NEAR_EXTENT_PROPERTY

static final java.lang.String MARGIN_LINE_NEAR_EXTENT_PROPERTY

The bound property of the line near margin extent.

MARGIN_LINE_FAR_EXTENT_PROPERTY

static final java.lang.String MARGIN_LINE_FAR_EXTENT_PROPERTY

The bound property of the line far margin extent.

MARGIN_PAGE_NEAR_EXTENT_PROPERTY

static final java.lang.String MARGIN_PAGE_NEAR_EXTENT_PROPERTY

The bound property of the page near margin extent.

MARGIN_PAGE_FAR_EXTENT_PROPERTY

static final java.lang.String MARGIN_PAGE_FAR_EXTENT_PROPERTY

The bound property of the page far margin extent.

OPACITY_PROPERTY

static final java.lang.String OPACITY_PROPERTY

The opacity bound property.

PADDING_LINE_NEAR_EXTENT_PROPERTY

static final java.lang.String PADDING_LINE_NEAR_EXTENT_PROPERTY

The bound property of the line near padding extent.

PADDING_LINE_FAR_EXTENT_PROPERTY

static final java.lang.String PADDING_LINE_FAR_EXTENT_PROPERTY

The bound property of the line far padding extent.

PADDING_PAGE_NEAR_EXTENT_PROPERTY

static final java.lang.String PADDING_PAGE_NEAR_EXTENT_PROPERTY

The bound property of the page near padding extent.

PADDING_PAGE_FAR_EXTENT_PROPERTY

static final java.lang.String PADDING_PAGE_FAR_EXTENT_PROPERTY

The bound property of the page far padding extent.

STYLE_ID_PROPERTY

static final java.lang.String STYLE_ID_PROPERTY

The bound property of the component style ID.

TEXT_COLOR_PROPERTY

static final java.lang.String TEXT_COLOR_PROPERTY

The bound property of the text color.

TOOLTIP_ENABLED_PROPERTY

static final java.lang.String TOOLTIP_ENABLED_PROPERTY

The bound property of whether the component has tooltips enabled.

VISIBLE_PROPERTY

static final java.lang.String VISIBLE_PROPERTY

The bound property of whether the component is visible.

ROUNDED_CORNER_ARC_SIZE

static final Dimensions ROUNDED_CORNER_ARC_SIZE

FONT_WEIGHT_NORMAL

static final double FONT_WEIGHT_NORMAL

The normal font weight.

See Also:

setFontWeight(double), Constant Field Values

FONT_WEIGHT_BOLD

static final double FONT_WEIGHT_BOLD

The bold font weight.

See Also:

setFontWeight(double), Constant Field Values

Method Detail

getBackgroundColor

Color getBackgroundColor()

Returns:

The background color of the component, or null if no background color is specified for this component.

setBackgroundColor

void setBackgroundColor(Color newBackgroundColor)

Sets the background color of the component. This is a bound property.

Parameters:

newBackgroundColor - The background color of the component, or null if the default background color should be used.

See Also:

BACKGROUND_COLOR_PROPERTY

getBorderColor

Color getBorderColor(Border border)

Returns the border color of the indicated border.

Parameters:

border - The border for which a border color should be returned.

Returns:

The border color of the given border, or null if the default border color should be used.

BorderLineNearColor

Color BorderLineNearColor()

Returns the border color of the line near page near border.

Returns:

The border color of the border, or null if the default border color should be used.

BorderLineFarColor

Color BorderLineFarColor()

Returns the border color of the line far page near border.

Returns:

The border color of the border, or null if the default border color should be used.

BorderPageNearColor

Color BorderPageNearColor()

Returns the border color of the line near page far border.

Returns:

The border color of the border, or null if the default border color should be used.

BorderPageFarColor

Color BorderPageFarColor()

Returns the border color of the line far page far border.

Returns:

The border color of the border, or null if the default border color should be used.

setBorderColor

void setBorderColor(Border border,
                    Color newBorderColor)

Sets the border color of a given border. The border color of each border represents a bound property.

Parameters:

border - The border for which the border color should be set.

newBorderColor - The border color, or null if the default border color should be used.

Throws:

java.lang.NullPointerException - if the given border is null.

See Also:

BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY

setBorderLineNearColor

void setBorderLineNearColor(Color newBorderColor)

Sets the border COLOR of the line near border. This is a bound property.

Parameters:

newBorderColor - The border color, or null if the default border color should be used.

See Also:

BORDER_LINE_NEAR_COLOR_PROPERTY

setBorderLineFarColor

void setBorderLineFarColor(Color newBorderColor)

Sets the border color of the line far border. This is a bound property.

Parameters:

newBorderColor - The border color, or null if the default border color should be used.

See Also:

BORDER_LINE_FAR_COLOR_PROPERTY

setBorderPageNearColor

void setBorderPageNearColor(Color newBorderColor)

Sets the border color of the page near border. This is a bound property.

Parameters:

newBorderColor - The border color, or null if the default border color should be used.

See Also:

BORDER_PAGE_NEAR_COLOR_PROPERTY

setBorderPageFarColor

void setBorderPageFarColor(Color newBorderColor)

Sets the border color of the page far border. This is a bound property.

Parameters:

newBorderColor - The border color, or null if the default border color should be used.

See Also:

BORDER_PAGE_FAR_COLOR_PROPERTY

setBorderColor

void setBorderColor(Color newBorderColor)

Sets the border color of all borders. The border color of each border represents a bound property. This is a convenience method that calls setBorderColor(Border, Color) for each border.

Parameters:

newBorderColor - The border color, or null if the default border color should be used.

See Also:

BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY

getBorderExtent

Extent getBorderExtent(Border border)

Returns the border extent of the indicated border.

Parameters:

border - The border for which a border extent should be returned.

Returns:

The border extent of the given border.

BorderLineNearExtent

Extent BorderLineNearExtent()

Returns the border extent of the line near page near border.

Returns:

The border extent of the given border.

BorderLineFarExtent

Extent BorderLineFarExtent()

Returns the border extent of the line far page near border.

Returns:

The border extent of the given border.

BorderPageNearExtent

Extent BorderPageNearExtent()

Returns the border extent of the line near page far border.

Returns:

The border extent of the given border.

BorderPageFarExtent

Extent BorderPageFarExtent()

Returns the border extent of the line far page far border.

Returns:

The border extent of the given border.

setBorderExtent

void setBorderExtent(Border border,
                     Extent newBorderExtent)

Sets the border extent of a given border. The border extent of each border represents a bound property.

Parameters:

border - The border for which the border extent should be set.

newBorderExtent - The border extent.

Throws:

java.lang.NullPointerException - if the given border and/or border extent is null.

See Also:

BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY

setBorderLineNearExtent

void setBorderLineNearExtent(Extent newBorderExtent)

Sets the border extent of the line near border. This is a bound property.

Parameters:

newBorderExtent - The border extent.

Throws:

java.lang.NullPointerException - if the given border extent is null.

See Also:

BORDER_LINE_NEAR_EXTENT_PROPERTY

setBorderLineFarExtent

void setBorderLineFarExtent(Extent newBorderExtent)

Sets the border extent of the line far border. This is a bound property.

Parameters:

newBorderExtent - The border extent.

Throws:

java.lang.NullPointerException - if the given border extent is null.

See Also:

BORDER_LINE_FAR_EXTENT_PROPERTY

setBorderPageNearExtent

void setBorderPageNearExtent(Extent newBorderExtent)

Sets the border extent of the page near border. This is a bound property.

Parameters:

newBorderExtent - The border extent.

Throws:

java.lang.NullPointerException - if the given border extent is null.

See Also:

BORDER_PAGE_NEAR_EXTENT_PROPERTY

setBorderPageFarExtent

void setBorderPageFarExtent(Extent newBorderExtent)

Sets the border extent of the page far border. This is a bound property.

Parameters:

newBorderExtent - The border extent.

Throws:

java.lang.NullPointerException - if the given border extent is null.

See Also:

BORDER_PAGE_FAR_EXTENT_PROPERTY

setBorderExtent

void setBorderExtent(Extent newBorderExtent)

Sets the border extent of all borders. The border extent of each border represents a bound property. This is a convenience method that calls setBorderExtent(Border, Extent) for each border.

Parameters:

newBorderExtent - The border extent.

Throws:

java.lang.NullPointerException - if the given border extent is null.

See Also:

BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY

getBorderStyle

LineStyle getBorderStyle(Border border)

Returns the border style of the indicated border.

Parameters:

border - The border for which a border style should be returned.

Returns:

The border style of the given border.

BorderLineNearStyle

LineStyle BorderLineNearStyle()

Returns the border style of the line near page near border.

Returns:

The border style of the given border.

BorderLineFarStyle

LineStyle BorderLineFarStyle()

Returns the border style of the line far page near border.

Returns:

The border style of the given border.

BorderPageNearStyle

LineStyle BorderPageNearStyle()

Returns the border style of the line near page far border.

Returns:

The border style of the given border.

BorderPageFarStyle

LineStyle BorderPageFarStyle()

Returns the border style of the line far page far border.

Returns:

The border style of the given border.

setBorderStyle

void setBorderStyle(Border border,
                    LineStyle newBorderStyle)

Sets the border style of a given border. The border style of each border represents a bound property.

Parameters:

border - The border for which the border style should be set.

newBorderStyle - The border style.

Throws:

java.lang.NullPointerException - if the given border and/or border style is null.

See Also:

BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY

setBorderLineNearStyle

void setBorderLineNearStyle(LineStyle newBorderStyle)

Sets the border style of the line near border. This is a bound property.

Parameters:

newBorderStyle - The border style.

Throws:

java.lang.NullPointerException - if the given border style is null.

See Also:

BORDER_LINE_NEAR_STYLE_PROPERTY

setBorderLineFarStyle

void setBorderLineFarStyle(LineStyle newBorderStyle)

Sets the border style of the line far border. This is a bound property.

Parameters:

newBorderStyle - The border style.

Throws:

java.lang.NullPointerException - if the given border style is null.

See Also:

BORDER_LINE_FAR_STYLE_PROPERTY

setBorderPageNearStyle

void setBorderPageNearStyle(LineStyle newBorderStyle)

Sets the border style of the page near border. This is a bound property.

Parameters:

newBorderStyle - The border style.

Throws:

java.lang.NullPointerException - if the given border style is null.

See Also:

BORDER_PAGE_NEAR_STYLE_PROPERTY

setBorderPageFarStyle

void setBorderPageFarStyle(LineStyle newBorderStyle)

Sets the border style of the page far border. This is a bound property.

Parameters:

newBorderStyle - The border style.

Throws:

java.lang.NullPointerException - if the given border style is null.

See Also:

BORDER_PAGE_FAR_STYLE_PROPERTY

setBorderStyle

void setBorderStyle(LineStyle newBorderStyle)

Sets the border style of all borders. The border style of each border represents a bound property. This is a convenience method that calls setBorderStyle(Border, LineStyle) for each border.

Parameters:

newBorderStyle - The border style.

Throws:

java.lang.NullPointerException - if the given border style is null.

See Also:

BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY

getCornerArcSize

Dimensions getCornerArcSize(Corner corner)

Returns the arc size for the indicated corner.

Parameters:

corner - The corner for which an arc size should be returned.

Returns:

The dimensions indicating the two radiuses of the given corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineNearPageNearArcSize

Dimensions getCornerLineNearPageNearArcSize()

Returns the arc size for the line near page near corner.

Returns:

The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineFarPageNearArcSize

Dimensions getCornerLineFarPageNearArcSize()

Returns the arc size for the line far page near corner.

Returns:

The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineNearPageFarArcSize

Dimensions getCornerLineNearPageFarArcSize()

Returns the arc size for the line near page far corner.

Returns:

The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

getCornerLineFarPageFarArcSize

Dimensions getCornerLineFarPageFarArcSize()

Returns the arc size for the line far page far corner.

Returns:

The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.

setCornerArcSize

void setCornerArcSize(Corner corner,
                      Dimensions newCornerArcSize)

Sets the arc size of a given corner. The radius of each corner represents a bound property.

Parameters:

corner - The corner for which the arc size should be set.

newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.

Throws:

java.lang.NullPointerException - if the given corner and/or arc size is null.

See Also:

CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

setCornerLineNearPageNearArcSize

void setCornerLineNearPageNearArcSize(Dimensions newCornerArcSize)

Sets the arc size of the line near page near corner. This is a bound property.

Parameters:

newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.

Throws:

java.lang.NullPointerException - if the given size is null.

See Also:

CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY

setCornerLineFarPageNearArcSize

void setCornerLineFarPageNearArcSize(Dimensions newCornerArcSize)

Sets the arc size of the line far page near corner. This is a bound property.

Parameters:

newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.

Throws:

java.lang.NullPointerException - if the given size is null.

See Also:

CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY

setCornerLineNearPageFarArcSize

void setCornerLineNearPageFarArcSize(Dimensions newCornerArcSize)

Sets the arc size of the line near page far corner. This is a bound property.

Parameters:

newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.

Throws:

java.lang.NullPointerException - if the given size is null.

See Also:

CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY

setCornerLineFarPageFarArcSize

void setCornerLineFarPageFarArcSize(Dimensions newCornerArcSize)

Sets the arc size of the line far page far corner. This is a bound property.

Parameters:

newCornerArcSize - The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.

Throws:

java.lang.NullPointerException - if the given size is null.

See Also:

CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

setCornerArcSize

void setCornerArcSize(Dimensions newCornerArcSize)

Sets the arc size of all corners. The radius of each corner represents a bound property. This is a convenience method that calls setCornerArcSize(Corner, Dimensions) for each corner.

Parameters:

newCornerArcSize - The dimensions indicating the two radiuses of the corners, or dimensions of zero if the corners should not be rounded.

Throws:

java.lang.NullPointerException - if the given arc size is null.

See Also:

CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY

getCursor

java.net.URI getCursor()

Returns:

The cursor URI, which may be a resource URI.

setCursor

void setCursor(java.net.URI newCursor)

Sets the URI of the cursor. This is a bound property.

Parameters:

newCursor - The new URI of the cursor, which may be a resource URI.

Throws:

java.lang.NullPointerException - if the given cursor URI is null.

See Also:

CURSOR_PROPERTY

getExtent

Extent getExtent(Flow flow)

Returns the extent of the indicated flow.

Parameters:

flow - The flow for which an extent should be returned.

Returns:

The extent of the given flow.

getLineExtent

Extent getLineExtent()

Returns the extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width.

Returns:

The extent of the flow, or null if no preferred extent has been specified

getPageExtent

Extent getPageExtent()

Returns the extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height.

Returns:

The extent of the flow, or null if no preferred extent has been specified

setExtent

void setExtent(Flow flow,
               Extent newExtent)

Sets the extent of a given flow. The extent of each flow represents a bound property.

Parameters:

flow - The flow for which the extent should be set.

newExtent - The new requested extent of the component, or null there is no extent preference.

Throws:

java.lang.NullPointerException - if the given flow is null.

See Also:

LINE_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY

setLineExtent

void setLineExtent(Extent newExtent)

Sets the extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width. This is a bound property.

Parameters:

newExtent - The new requested extent of the component, or null there is no extent preference.

See Also:

LINE_EXTENT_PROPERTY

setPageExtent

void setPageExtent(Extent newExtent)

Sets the extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height. This is a bound property.

Parameters:

newExtent - The new requested extent of the component, or null there is no extent preference.

See Also:

PAGE_EXTENT_PROPERTY

getFontFamilies

java.util.List<java.lang.String> getFontFamilies()

Returns:

The prioritized list of font family names, or null if no font family names have been specified.

setFontFamilies

void setFontFamilies(java.util.List<java.lang.String> newFontFamilies)

Sets the font families of the component. This is a bound property.

Parameters:

newFontFamilies - The new prioritized list of font family names, or null if no font family names are specified.

See Also:

FONT_FAMILIES_PROPERTY

getFontSize

Extent getFontSize()

Returns:

The size of the font from baseline to baseline, or null if no font size has been specified.

setFontSize

void setFontSize(Extent newFontSize)

Sets the font size of the component. This is a bound property.

Parameters:

newFontSize - The new size of the font from baseline to baseline, or null there is no font size specified.

See Also:

FONT_SIZE_PROPERTY

getFontStyle

FontStyle getFontStyle()

Returns:

The style of the font.

setFontStyle

void setFontStyle(FontStyle newFontStyle)

Sets the style of the font. This is a bound property.

Parameters:

newFontStyle - The style of the font.

Throws:

java.lang.NullPointerException - if the given font style is null.

See Also:

FONT_STYLE_PROPERTY

getFontWeight

double getFontWeight()

Returns:

The weight of a font relative to a normal value of 0.5.

setFontWeight

void setFontWeight(double newFontWeight)

Sets the weight of the font. The weight of a font relative to a normal value of 0.5. A font weight of 0.75 is equivalent to a bold font. It is recommended that the constant variables FONT_WEIGHT_NORMAL and FONT_WEIGHT_BOLD be used for the most compatibility across platforms. This is a bound property of type Double.

Parameters:

newFontWeight - The weight of a font relative to a normal value of 0.5.

See Also:

FONT_WEIGHT_PROPERTY, FONT_WEIGHT_NORMAL, FONT_WEIGHT_BOLD

getLabelFontFamilies

java.util.List<java.lang.String> getLabelFontFamilies()

Returns:

The prioritized list of label font family names, or null if no label font family names have been specified.

setLabelFontFamilies

void setLabelFontFamilies(java.util.List<java.lang.String> newLabelFontFamilies)

Sets the font families of the label. This is a bound property.

Parameters:

newLabelFontFamilies - The new prioritized list of label font family names, or null if no label font family names are specified.

See Also:

LABEL_FONT_FAMILIES_PROPERTY

getLabelFontSize

Extent getLabelFontSize()

Returns:

The size of the label font from baseline to baseline, or null if no label font size has been specified.

setLabelFontSize

void setLabelFontSize(Extent newLabelFontSize)

Sets the label font size of the component. This is a bound property.

Parameters:

newLabelFontSize - The new size of the label font from baseline to baseline, or null there is no label font size specified.

See Also:

LABEL_FONT_SIZE_PROPERTY

getLabelFontStyle

FontStyle getLabelFontStyle()

Returns:

The style of the label font.

setLabelFontStyle

void setLabelFontStyle(FontStyle newLabelFontStyle)

Sets the style of the label font. This is a bound property.

Parameters:

newLabelFontStyle - The style of the label font.

Throws:

java.lang.NullPointerException - if the given label font style is null.

See Also:

LABEL_FONT_STYLE_PROPERTY

getLabelFontWeight

double getLabelFontWeight()

Returns:

The weight of the label font relative to a normal value of 0.5.

setLabelFontWeight

void setLabelFontWeight(double newLabelFontWeight)

Sets the weight of the label font. The weight of the label font relative to a normal value of 0.5. A font weight of 0.75 is equivalent to a bold font. It is recommended that the constant variables FONT_WEIGHT_NORMAL and FONT_WEIGHT_BOLD be used for the most compatibility across platforms. This is a bound property of type Double.

Parameters:

newLabelFontWeight - The weight of the label font relative to a normal value of 0.5.

See Also:

FONT_WEIGHT_PROPERTY, FONT_WEIGHT_NORMAL, FONT_WEIGHT_BOLD

getLabelTextColor

Color getLabelTextColor()

Returns:

The text color of the label, or null if no text color is specified for the label.

setLabelTextColor

void setLabelTextColor(Color newLabelTextColor)

Sets the text color of the label. This is a bound property.

Parameters:

newLabelTextColor - The text color of the label, or null if the default text color should be used.

See Also:

LABEL_TEXT_COLOR_PROPERTY

getMarginExtent

Extent getMarginExtent(Border border)

Returns the margin extent of the indicated border.

Parameters:

border - The border for which a margin extent should be returned.

Returns:

The margin extent of the given border.

getMarginLineNearExtent

Extent getMarginLineNearExtent()

Returns the margin extent of the line near page near border.

Returns:

The margin extent of the given border.

getMarginLineFarExtent

Extent getMarginLineFarExtent()

Returns the margin extent of the line far page near border.

Returns:

The margin extent of the given border.

getMarginPageNearExtent

Extent getMarginPageNearExtent()

Returns the margin extent of the line near page far border.

Returns:

The margin extent of the given border.

getMarginPageFarExtent

Extent getMarginPageFarExtent()

Returns the margin extent of the line far page far border.

Returns:

The margin extent of the given border.

setMarginExtent

void setMarginExtent(Border border,
                     Extent newMarginExtent)

Sets the margin extent of a given border. The margin extent of each border represents a bound property.

Parameters:

border - The border for which the margin extent should be set.

newMarginExtent - The margin extent.

Throws:

java.lang.NullPointerException - if the given border and/or margin extent is null.

See Also:

MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY

setMarginLineNearExtent

void setMarginLineNearExtent(Extent newMarginExtent)

Sets the margin extent of the line near border. This is a bound property.

Parameters:

newMarginExtent - The margin extent.

Throws:

java.lang.NullPointerException - if the given margin extent is null.

See Also:

MARGIN_LINE_NEAR_EXTENT_PROPERTY

setMarginLineFarExtent

void setMarginLineFarExtent(Extent newMarginExtent)

Sets the margin extent of the line far border. This is a bound property.

Parameters:

newMarginExtent - The margin extent, or null if the default margin extent should be used.

Throws:

java.lang.NullPointerException - if the given margin extent is null.

See Also:

MARGIN_LINE_FAR_EXTENT_PROPERTY

setMarginPageNearExtent

void setMarginPageNearExtent(Extent newMarginExtent)

Sets the margin extent of the page near border. This is a bound property.

Parameters:

newMarginExtent - The margin extent, or null if the default margin extent should be used.

Throws:

java.lang.NullPointerException - if the given margin extent is null.

See Also:

MARGIN_PAGE_NEAR_EXTENT_PROPERTY

setMarginPageFarExtent

void setMarginPageFarExtent(Extent newMarginExtent)

Sets the margin extent of the page far border. This is a bound property.

Parameters:

newMarginExtent - The margin extent, or null if the default margin extent should be used.

Throws:

java.lang.NullPointerException - if the given margin extent is null.

See Also:

MARGIN_PAGE_FAR_EXTENT_PROPERTY

setMarginExtent

void setMarginExtent(Extent newMarginExtent)

Sets the margin extent of all borders. The margin extent of each border represents a bound property. This is a convenience method that calls setMarginExtent(Border, Extent) for each border.

Parameters:

newMarginExtent - The margin extent.

Throws:

java.lang.NullPointerException - if the given margin extent is null.

See Also:

MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY

getOpacity

double getOpacity()

Returns:

The opacity of the entire component in the range (0.0-1.0), with a default of 1.0.

setOpacity

void setOpacity(double newOpacity)

Sets the opacity of the entire component. This is a bound property of type Double.

Parameters:

newOpacity - The new opacity of the entire component in the range (0.0-1.0).

Throws:

java.lang.IllegalArgumentException - if the given opacity is not within the range (0.0-1.0).

See Also:

OPACITY_PROPERTY

getPaddingExtent

Extent getPaddingExtent(Border border)

Returns the padding extent of the indicated border.

Parameters:

border - The border for which a padding extent should be returned.

Returns:

The padding extent of the given border.

getPaddingLineNearExtent

Extent getPaddingLineNearExtent()

Returns the padding extent of the line near page near border.

Returns:

The padding extent of the given border.

getPaddingLineFarExtent

Extent getPaddingLineFarExtent()

Returns the padding extent of the line far page near border.

Returns:

The padding extent of the given border.

getPaddingPageNearExtent

Extent getPaddingPageNearExtent()

Returns the padding extent of the line near page far border.

Returns:

The padding extent of the given border.

getPaddingPageFarExtent

Extent getPaddingPageFarExtent()

Returns the padding extent of the line far page far border.

Returns:

The padding extent of the given border.

setPaddingExtent

void setPaddingExtent(Border border,
                      Extent newPaddingExtent)

Sets the padding extent of a given border. The padding extent of each border represents a bound property.

Parameters:

border - The border for which the padding extent should be set.

newPaddingExtent - The padding extent.

Throws:

java.lang.NullPointerException - if the given border and/or padding extent is null.

See Also:

PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY

setPaddingLineNearExtent

void setPaddingLineNearExtent(Extent newPaddingExtent)

Sets the padding extent of the line near border. This is a bound property.

Parameters:

newPaddingExtent - The padding extent.

Throws:

java.lang.NullPointerException - if the given padding extent is null.

See Also:

PADDING_LINE_NEAR_EXTENT_PROPERTY

setPaddingLineFarExtent

void setPaddingLineFarExtent(Extent newPaddingExtent)

Sets the padding extent of the line far border. This is a bound property.

Parameters:

newPaddingExtent - The padding extent, or null if the default padding extent should be used.

Throws:

java.lang.NullPointerException - if the given padding extent is null.

See Also:

PADDING_LINE_FAR_EXTENT_PROPERTY

setPaddingPageNearExtent

void setPaddingPageNearExtent(Extent newPaddingExtent)

Sets the padding extent of the page near border. This is a bound property.

Parameters:

newPaddingExtent - The padding extent, or null if the default padding extent should be used.

Throws:

java.lang.NullPointerException - if the given padding extent is null.

See Also:

PADDING_PAGE_NEAR_EXTENT_PROPERTY

setPaddingPageFarExtent

void setPaddingPageFarExtent(Extent newPaddingExtent)

Sets the padding extent of the page far border. This is a bound property.

Parameters:

newPaddingExtent - The padding extent, or null if the default padding extent should be used.

Throws:

java.lang.NullPointerException - if the given padding extent is null.

See Also:

PADDING_PAGE_FAR_EXTENT_PROPERTY

setPaddingExtent

void setPaddingExtent(Extent newPaddingExtent)

Sets the padding extent of all borders. The padding extent of each border represents a bound property. This is a convenience method that calls setPaddingExtent(Border, Extent) for each border.

Parameters:

newPaddingExtent - The padding extent.

Throws:

java.lang.NullPointerException - if the given padding extent is null.

See Also:

PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY

getSession

GuiseSession getSession()

Returns:

The Guise session that owns this component.

getStyleID

java.lang.String getStyleID()

Returns:

The style identifier, or null if there is no style ID.

setStyleID

void setStyleID(java.lang.String newStyleID)

Identifies the style for the component. This is a bound property.

Parameters:

newStyleID - The style identifier, or null if there is no style ID.

See Also:

STYLE_ID_PROPERTY

isVisible

boolean isVisible()

Returns:

Whether the component is visible.

See Also:

isDisplayed()

setVisible

void setVisible(boolean newVisible)

Sets whether the component is visible. This is a bound property of type Boolean.

Parameters:

newVisible - true if the component should be visible, else false.

See Also:

VISIBLE_PROPERTY, setDisplayed(boolean)

isDisplayed

boolean isDisplayed()

Specified by:

isDisplayed in interface Displayable

Returns:

Whether the component is displayed or has no representation, taking up no space.

See Also:

isVisible()

setDisplayed

void setDisplayed(boolean newDisplayed)

Sets whether the component is displayed or has no representation, taking up no space. This is a bound property of type Boolean.

Specified by:

setDisplayed in interface Displayable

Parameters:

newDisplayed - true if the component should be displayed, else false if the component should take up no space.

See Also:

Displayable.DISPLAYED_PROPERTY, setVisible(boolean)

getTextColor

Color getTextColor()

Returns:

The text color of the component, or null if no text color is specified.

setTextColor

void setTextColor(Color newTextColor)

Sets the text color of the component. This is a bound property.

Parameters:

newTextColor - The text color of the component, or null if the default text color should be used.

See Also:

TEXT_COLOR_PROPERTY

isTooltipEnabled

boolean isTooltipEnabled()

Returns:

Whether tooltips are enabled for this component.

setTooltipEnabled

void setTooltipEnabled(boolean newTooltipEnabled)

Sets whether tooltips are enabled for this component. Tooltips contain information from the component model's "info" property. This is a bound property of type Boolean.

Parameters:

newTooltipEnabled - true if the component should display tooltips, else false.

See Also:

Model#getInfo(), TOOLTIP_ENABLED_PROPERTY