Package io.guise.framework.model.ui
Class AbstractPresentationModel
java.lang.Object
com.globalmentor.beans.BoundPropertyObject
io.guise.framework.event.GuiseBoundPropertyObject
io.guise.framework.model.ui.AbstractPresentationModel
- All Implemented Interfaces:
com.globalmentor.beans.PropertyBindable
,com.globalmentor.beans.PropertyConstrainable
,Displayable
,Model
,PresentationModel
- Direct Known Subclasses:
AbstractComponent
,Table.ColumnUIModel
public abstract class AbstractPresentationModel
extends GuiseBoundPropertyObject
implements PresentationModel
An abstract implementation of presentation-related information.
- Author:
- Garret Wilson
-
Field Summary
Fields inherited from class com.globalmentor.beans.BoundPropertyObject
NO_PROPERTY_CHANGE_LISTENERS, NO_VETOABLE_CHANGE_LISTENERS
Fields inherited from interface io.guise.framework.model.Displayable
DISPLAYED_PROPERTY
Fields inherited from interface io.guise.framework.model.ui.PresentationModel
BACKGROUND_COLOR_PROPERTY, BORDER_LINE_FAR_COLOR_PROPERTY, BORDER_LINE_FAR_EXTENT_PROPERTY, BORDER_LINE_FAR_STYLE_PROPERTY, BORDER_LINE_NEAR_COLOR_PROPERTY, BORDER_LINE_NEAR_EXTENT_PROPERTY, BORDER_LINE_NEAR_STYLE_PROPERTY, BORDER_PAGE_FAR_COLOR_PROPERTY, BORDER_PAGE_FAR_EXTENT_PROPERTY, BORDER_PAGE_FAR_STYLE_PROPERTY, BORDER_PAGE_NEAR_COLOR_PROPERTY, BORDER_PAGE_NEAR_EXTENT_PROPERTY, BORDER_PAGE_NEAR_STYLE_PROPERTY, CORNER_LINE_FAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_FAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_FAR_ARC_SIZE_PROPERTY, CORNER_LINE_NEAR_PAGE_NEAR_ARC_SIZE_PROPERTY, CURSOR_PROPERTY, FONT_FAMILIES_PROPERTY, FONT_SIZE_PROPERTY, FONT_STYLE_PROPERTY, FONT_WEIGHT_BOLD, FONT_WEIGHT_NORMAL, FONT_WEIGHT_PROPERTY, LABEL_FONT_FAMILIES_PROPERTY, LABEL_FONT_SIZE_PROPERTY, LABEL_FONT_STYLE_PROPERTY, LABEL_FONT_WEIGHT_PROPERTY, LABEL_TEXT_COLOR_PROPERTY, LINE_EXTENT_PROPERTY, MARGIN_LINE_FAR_EXTENT_PROPERTY, MARGIN_LINE_NEAR_EXTENT_PROPERTY, MARGIN_PAGE_FAR_EXTENT_PROPERTY, MARGIN_PAGE_NEAR_EXTENT_PROPERTY, OPACITY_PROPERTY, PADDING_LINE_FAR_EXTENT_PROPERTY, PADDING_LINE_NEAR_EXTENT_PROPERTY, PADDING_PAGE_FAR_EXTENT_PROPERTY, PADDING_PAGE_NEAR_EXTENT_PROPERTY, PAGE_EXTENT_PROPERTY, ROUNDED_CORNER_ARC_SIZE, STYLE_ID_PROPERTY, TEXT_COLOR_PROPERTY, TOOLTIP_ENABLED_PROPERTY, VISIBLE_PROPERTY
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the border color of the line far page near border.Returns the border extent of the line far page near border.Returns the border style of the line far page near border.Returns the border color of the line near page near border.Returns the border extent of the line near page near border.Returns the border style of the line near page near border.Returns the border color of the line far page far border.Returns the border extent of the line far page far border.Returns the border style of the line far page far border.Returns the border color of the line near page far border.Returns the border extent of the line near page far border.Returns the border style of the line near page far border.getBorderColor
(Border border) Returns the border color of the indicated border.getBorderExtent
(Border border) Returns the border extent of the indicated border.getBorderStyle
(Border border) Returns the border style of the indicated border.getCornerArcSize
(Corner corner) Returns the arc size for the indicated corner.Returns the arc size for the line far page far corner.Returns the arc size for the line far page near corner.Returns the arc size for the line near page far corner.Returns the arc size for the line near page near corner.Returns the extent of the indicated flow.double
double
Returns the extent of the line flow.getMarginExtent
(Border border) Returns the margin extent of the indicated border.Returns the margin extent of the line far page near border.Returns the margin extent of the line near page near border.Returns the margin extent of the line far page far border.Returns the margin extent of the line near page far border.double
getPaddingExtent
(Border border) Returns the padding extent of the indicated border.Returns the padding extent of the line far page near border.Returns the padding extent of the line near page near border.Returns the padding extent of the line far page far border.Returns the padding extent of the line near page far border.Returns the extent of the page flow.boolean
boolean
boolean
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
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
Sets the extent of a given flow.void
setFontFamilies
(List<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
(List<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
(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 class io.guise.framework.event.GuiseBoundPropertyObject
getSession
Methods inherited from class com.globalmentor.beans.BoundPropertyObject
addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, addVetoableChangeListener, createPostponedPropertyChangeEvent, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, fireVetoableChange, getForwardPropertyChangeListener, getPropertyChangeListeners, getPropertyChangeListeners, getPropertyChangeSupport, getRepeatPropertyChangeListener, getRepeatVetoableChangeListener, getVetoableChangeListeners, getVetoableChangeListeners, getVetoableChangeSupport, hasPropertyChangeListeners, hasVetoableChangeListeners, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, removeVetoableChangeListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.guise.framework.model.ui.PresentationModel
getSession
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
-
Constructor Details
-
AbstractPresentationModel
public AbstractPresentationModel()Default constructor.
-
-
Method Details
-
getBackgroundColor
- Specified by:
getBackgroundColor
in interfacePresentationModel
- Returns:
- The background color of the component, or
null
if no background color is specified for this component.
-
setBackgroundColor
Description copied from interface:PresentationModel
Sets the background color of the component. This is a bound property.- Specified by:
setBackgroundColor
in interfacePresentationModel
- Parameters:
newBackgroundColor
- The background color of the component, ornull
if the default background color should be used.- See Also:
-
getBorderColor
Description copied from interface:PresentationModel
Returns the border color of the indicated border.- Specified by:
getBorderColor
in interfacePresentationModel
- 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
Returns the border color of the line near page near border.- Specified by:
BorderLineNearColor
in interfacePresentationModel
- Returns:
- The border color of the border, or
null
if the default border color should be used.
-
BorderLineFarColor
Description copied from interface:PresentationModel
Returns the border color of the line far page near border.- Specified by:
BorderLineFarColor
in interfacePresentationModel
- Returns:
- The border color of the border, or
null
if the default border color should be used.
-
BorderPageNearColor
Description copied from interface:PresentationModel
Returns the border color of the line near page far border.- Specified by:
BorderPageNearColor
in interfacePresentationModel
- Returns:
- The border color of the border, or
null
if the default border color should be used.
-
BorderPageFarColor
Description copied from interface:PresentationModel
Returns the border color of the line far page far border.- Specified by:
BorderPageFarColor
in interfacePresentationModel
- Returns:
- The border color of the border, or
null
if the default border color should be used.
-
setBorderColor
Description copied from interface:PresentationModel
Sets the border color of a given border. The border color of each border represents a bound property.- Specified by:
setBorderColor
in interfacePresentationModel
- Parameters:
border
- The border for which the border color should be set.newBorderColor
- The border color, ornull
if the default border color should be used.- See Also:
-
setBorderLineNearColor
Description copied from interface:PresentationModel
Sets the border COLOR of the line near border. This is a bound property.- Specified by:
setBorderLineNearColor
in interfacePresentationModel
- Parameters:
newBorderColor
- The border color, ornull
if the default border color should be used.- See Also:
-
setBorderLineFarColor
Description copied from interface:PresentationModel
Sets the border color of the line far border. This is a bound property.- Specified by:
setBorderLineFarColor
in interfacePresentationModel
- Parameters:
newBorderColor
- The border color, ornull
if the default border color should be used.- See Also:
-
setBorderPageNearColor
Description copied from interface:PresentationModel
Sets the border color of the page near border. This is a bound property.- Specified by:
setBorderPageNearColor
in interfacePresentationModel
- Parameters:
newBorderColor
- The border color, ornull
if the default border color should be used.- See Also:
-
setBorderPageFarColor
Description copied from interface:PresentationModel
Sets the border color of the page far border. This is a bound property.- Specified by:
setBorderPageFarColor
in interfacePresentationModel
- Parameters:
newBorderColor
- The border color, ornull
if the default border color should be used.- See Also:
-
setBorderColor
Description copied from interface:PresentationModel
Sets the border color of all borders. The border color of each border represents a bound property. This is a convenience method that callsPresentationModel.setBorderColor(Border, Color)
for each border.- Specified by:
setBorderColor
in interfacePresentationModel
- Parameters:
newBorderColor
- The border color, ornull
if the default border color should be used.- See Also:
-
getBorderExtent
Description copied from interface:PresentationModel
Returns the border extent of the indicated border.- Specified by:
getBorderExtent
in interfacePresentationModel
- Parameters:
border
- The border for which a border extent should be returned.- Returns:
- The border extent of the given border.
-
BorderLineNearExtent
Description copied from interface:PresentationModel
Returns the border extent of the line near page near border.- Specified by:
BorderLineNearExtent
in interfacePresentationModel
- Returns:
- The border extent of the given border.
-
BorderLineFarExtent
Description copied from interface:PresentationModel
Returns the border extent of the line far page near border.- Specified by:
BorderLineFarExtent
in interfacePresentationModel
- Returns:
- The border extent of the given border.
-
BorderPageNearExtent
Description copied from interface:PresentationModel
Returns the border extent of the line near page far border.- Specified by:
BorderPageNearExtent
in interfacePresentationModel
- Returns:
- The border extent of the given border.
-
BorderPageFarExtent
Description copied from interface:PresentationModel
Returns the border extent of the line far page far border.- Specified by:
BorderPageFarExtent
in interfacePresentationModel
- Returns:
- The border extent of the given border.
-
setBorderExtent
Description copied from interface:PresentationModel
Sets the border extent of a given border. The border extent of each border represents a bound property.- Specified by:
setBorderExtent
in interfacePresentationModel
- Parameters:
border
- The border for which the border extent should be set.newBorderExtent
- The border extent.- See Also:
-
setBorderLineNearExtent
Description copied from interface:PresentationModel
Sets the border extent of the line near border. This is a bound property.- Specified by:
setBorderLineNearExtent
in interfacePresentationModel
- Parameters:
newBorderExtent
- The border extent.- See Also:
-
setBorderLineFarExtent
Description copied from interface:PresentationModel
Sets the border extent of the line far border. This is a bound property.- Specified by:
setBorderLineFarExtent
in interfacePresentationModel
- Parameters:
newBorderExtent
- The border extent.- See Also:
-
setBorderPageNearExtent
Description copied from interface:PresentationModel
Sets the border extent of the page near border. This is a bound property.- Specified by:
setBorderPageNearExtent
in interfacePresentationModel
- Parameters:
newBorderExtent
- The border extent.- See Also:
-
setBorderPageFarExtent
Description copied from interface:PresentationModel
Sets the border extent of the page far border. This is a bound property.- Specified by:
setBorderPageFarExtent
in interfacePresentationModel
- Parameters:
newBorderExtent
- The border extent.- See Also:
-
setBorderExtent
Description copied from interface:PresentationModel
Sets the border extent of all borders. The border extent of each border represents a bound property. This is a convenience method that callsPresentationModel.setBorderExtent(Border, Extent)
for each border.- Specified by:
setBorderExtent
in interfacePresentationModel
- Parameters:
newBorderExtent
- The border extent.- See Also:
-
getBorderStyle
Description copied from interface:PresentationModel
Returns the border style of the indicated border.- Specified by:
getBorderStyle
in interfacePresentationModel
- Parameters:
border
- The border for which a border style should be returned.- Returns:
- The border style of the given border.
-
BorderLineNearStyle
Description copied from interface:PresentationModel
Returns the border style of the line near page near border.- Specified by:
BorderLineNearStyle
in interfacePresentationModel
- Returns:
- The border style of the given border.
-
BorderLineFarStyle
Description copied from interface:PresentationModel
Returns the border style of the line far page near border.- Specified by:
BorderLineFarStyle
in interfacePresentationModel
- Returns:
- The border style of the given border.
-
BorderPageNearStyle
Description copied from interface:PresentationModel
Returns the border style of the line near page far border.- Specified by:
BorderPageNearStyle
in interfacePresentationModel
- Returns:
- The border style of the given border.
-
BorderPageFarStyle
Description copied from interface:PresentationModel
Returns the border style of the line far page far border.- Specified by:
BorderPageFarStyle
in interfacePresentationModel
- Returns:
- The border style of the given border.
-
setBorderStyle
Description copied from interface:PresentationModel
Sets the border style of a given border. The border style of each border represents a bound property.- Specified by:
setBorderStyle
in interfacePresentationModel
- Parameters:
border
- The border for which the border style should be set.newBorderStyle
- The border style.- See Also:
-
setBorderLineNearStyle
Description copied from interface:PresentationModel
Sets the border style of the line near border. This is a bound property.- Specified by:
setBorderLineNearStyle
in interfacePresentationModel
- Parameters:
newBorderStyle
- The border style.- See Also:
-
setBorderLineFarStyle
Description copied from interface:PresentationModel
Sets the border style of the line far border. This is a bound property.- Specified by:
setBorderLineFarStyle
in interfacePresentationModel
- Parameters:
newBorderStyle
- The border style.- See Also:
-
setBorderPageNearStyle
Description copied from interface:PresentationModel
Sets the border style of the page near border. This is a bound property.- Specified by:
setBorderPageNearStyle
in interfacePresentationModel
- Parameters:
newBorderStyle
- The border style.- See Also:
-
setBorderPageFarStyle
Description copied from interface:PresentationModel
Sets the border style of the page far border. This is a bound property.- Specified by:
setBorderPageFarStyle
in interfacePresentationModel
- Parameters:
newBorderStyle
- The border style.- See Also:
-
setBorderStyle
Description copied from interface:PresentationModel
Sets the border style of all borders. The border style of each border represents a bound property. This is a convenience method that callsPresentationModel.setBorderStyle(Border, LineStyle)
for each border.- Specified by:
setBorderStyle
in interfacePresentationModel
- Parameters:
newBorderStyle
- The border style.- See Also:
-
getCornerArcSize
Description copied from interface:PresentationModel
Returns the arc size for the indicated corner.- Specified by:
getCornerArcSize
in interfacePresentationModel
- 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
Description copied from interface:PresentationModel
Returns the arc size for the line near page near corner.- Specified by:
getCornerLineNearPageNearArcSize
in interfacePresentationModel
- Returns:
- The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.
-
getCornerLineFarPageNearArcSize
Description copied from interface:PresentationModel
Returns the arc size for the line far page near corner.- Specified by:
getCornerLineFarPageNearArcSize
in interfacePresentationModel
- Returns:
- The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.
-
getCornerLineNearPageFarArcSize
Description copied from interface:PresentationModel
Returns the arc size for the line near page far corner.- Specified by:
getCornerLineNearPageFarArcSize
in interfacePresentationModel
- Returns:
- The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.
-
getCornerLineFarPageFarArcSize
Description copied from interface:PresentationModel
Returns the arc size for the line far page far corner.- Specified by:
getCornerLineFarPageFarArcSize
in interfacePresentationModel
- Returns:
- The dimensions indicating the two radiuses of the corner arc, or dimensions of zero if the corner should not be rounded.
-
setCornerArcSize
Description copied from interface:PresentationModel
Sets the arc size of a given corner. The radius of each corner represents a bound property.- Specified by:
setCornerArcSize
in interfacePresentationModel
- 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.- See Also:
-
setCornerLineNearPageNearArcSize
Description copied from interface:PresentationModel
Sets the arc size of the line near page near corner. This is a bound property.- Specified by:
setCornerLineNearPageNearArcSize
in interfacePresentationModel
- Parameters:
newCornerArcSize
- The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.- See Also:
-
setCornerLineFarPageNearArcSize
Description copied from interface:PresentationModel
Sets the arc size of the line far page near corner. This is a bound property.- Specified by:
setCornerLineFarPageNearArcSize
in interfacePresentationModel
- Parameters:
newCornerArcSize
- The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.- See Also:
-
setCornerLineNearPageFarArcSize
Description copied from interface:PresentationModel
Sets the arc size of the line near page far corner. This is a bound property.- Specified by:
setCornerLineNearPageFarArcSize
in interfacePresentationModel
- Parameters:
newCornerArcSize
- The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.- See Also:
-
setCornerLineFarPageFarArcSize
Description copied from interface:PresentationModel
Sets the arc size of the line far page far corner. This is a bound property.- Specified by:
setCornerLineFarPageFarArcSize
in interfacePresentationModel
- Parameters:
newCornerArcSize
- The dimensions indicating the two radiuses of the corner, or dimensions of zero if the corner should not be rounded.- See Also:
-
setCornerArcSize
Description copied from interface:PresentationModel
Sets the arc size of all corners. The radius of each corner represents a bound property. This is a convenience method that callsPresentationModel.setCornerArcSize(Corner, Dimensions)
for each corner.- Specified by:
setCornerArcSize
in interfacePresentationModel
- Parameters:
newCornerArcSize
- The dimensions indicating the two radiuses of the corners, or dimensions of zero if the corners should not be rounded.- See Also:
-
getCursor
- Specified by:
getCursor
in interfacePresentationModel
- Returns:
- The cursor URI, which may be a resource URI.
-
setCursor
Description copied from interface:PresentationModel
Sets the URI of the cursor. This is a bound property.- Specified by:
setCursor
in interfacePresentationModel
- Parameters:
newCursor
- The new URI of the cursor, which may be a resource URI.- See Also:
-
getExtent
Description copied from interface:PresentationModel
Returns the extent of the indicated flow.- Specified by:
getExtent
in interfacePresentationModel
- Parameters:
flow
- The flow for which an extent should be returned.- Returns:
- The extent of the given flow.
-
getLineExtent
Description copied from interface:PresentationModel
Returns the extent of the line flow. In left-to-right top-to-bottom orientation, this is commonly known as the width.- Specified by:
getLineExtent
in interfacePresentationModel
- Returns:
- The extent of the flow, or
null
if no preferred extent has been specified
-
getPageExtent
Description copied from interface:PresentationModel
Returns the extent of the page flow. In left-to-right top-to-bottom orientation, this is commonly known as the height.- Specified by:
getPageExtent
in interfacePresentationModel
- Returns:
- The extent of the flow, or
null
if no preferred extent has been specified
-
setExtent
Description copied from interface:PresentationModel
Sets the extent of a given flow. The extent of each flow represents a bound property.- Specified by:
setExtent
in interfacePresentationModel
- Parameters:
flow
- The flow for which the extent should be set.newExtent
- The new requested extent of the component, ornull
there is no extent preference.- See Also:
-
setLineExtent
Description copied from interface:PresentationModel
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.- Specified by:
setLineExtent
in interfacePresentationModel
- Parameters:
newExtent
- The new requested extent of the component, ornull
there is no extent preference.- See Also:
-
setPageExtent
Description copied from interface:PresentationModel
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.- Specified by:
setPageExtent
in interfacePresentationModel
- Parameters:
newExtent
- The new requested extent of the component, ornull
there is no extent preference.- See Also:
-
getFontFamilies
- Specified by:
getFontFamilies
in interfacePresentationModel
- Returns:
- The prioritized list of font family names, or
null
if no font family names have been specified.
-
setFontFamilies
Description copied from interface:PresentationModel
Sets the font families of the component. This is a bound property.- Specified by:
setFontFamilies
in interfacePresentationModel
- Parameters:
newFontFamilies
- The new prioritized list of font family names, ornull
if no font family names are specified.- See Also:
-
getFontSize
- Specified by:
getFontSize
in interfacePresentationModel
- Returns:
- The size of the font from baseline to baseline, or
null
if no font size has been specified.
-
setFontSize
Description copied from interface:PresentationModel
Sets the font size of the component. This is a bound property.- Specified by:
setFontSize
in interfacePresentationModel
- Parameters:
newFontSize
- The new size of the font from baseline to baseline, ornull
there is no font size specified.- See Also:
-
getFontStyle
- Specified by:
getFontStyle
in interfacePresentationModel
- Returns:
- The style of the font.
-
setFontStyle
Description copied from interface:PresentationModel
Sets the style of the font. This is a bound property.- Specified by:
setFontStyle
in interfacePresentationModel
- Parameters:
newFontStyle
- The style of the font.- See Also:
-
getFontWeight
public double getFontWeight()- Specified by:
getFontWeight
in interfacePresentationModel
- Returns:
- The weight of a font relative to a normal value of 0.5.
-
setFontWeight
public void setFontWeight(double newFontWeight) Description copied from interface:PresentationModel
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 variablesPresentationModel.FONT_WEIGHT_NORMAL
andPresentationModel.FONT_WEIGHT_BOLD
be used for the most compatibility across platforms. This is a bound property of typeDouble
.- Specified by:
setFontWeight
in interfacePresentationModel
- Parameters:
newFontWeight
- The weight of a font relative to a normal value of 0.5.- See Also:
-
getLabelFontFamilies
- Specified by:
getLabelFontFamilies
in interfacePresentationModel
- Returns:
- The prioritized list of label font family names, or
null
if no label font family names have been specified.
-
setLabelFontFamilies
Description copied from interface:PresentationModel
Sets the font families of the label. This is a bound property.- Specified by:
setLabelFontFamilies
in interfacePresentationModel
- Parameters:
newLabelFontFamilies
- The new prioritized list of label font family names, ornull
if no label font family names are specified.- See Also:
-
getLabelFontSize
- Specified by:
getLabelFontSize
in interfacePresentationModel
- Returns:
- The size of the label font from baseline to baseline, or
null
if no label font size has been specified.
-
setLabelFontSize
Description copied from interface:PresentationModel
Sets the label font size of the component. This is a bound property.- Specified by:
setLabelFontSize
in interfacePresentationModel
- Parameters:
newLabelFontSize
- The new size of the label font from baseline to baseline, ornull
there is no label font size specified.- See Also:
-
getLabelFontStyle
- Specified by:
getLabelFontStyle
in interfacePresentationModel
- Returns:
- The style of the label font.
-
setLabelFontStyle
Description copied from interface:PresentationModel
Sets the style of the label font. This is a bound property.- Specified by:
setLabelFontStyle
in interfacePresentationModel
- Parameters:
newLabelFontStyle
- The style of the label font.- See Also:
-
getLabelFontWeight
public double getLabelFontWeight()- Specified by:
getLabelFontWeight
in interfacePresentationModel
- Returns:
- The weight of the label font relative to a normal value of 0.5.
-
setLabelFontWeight
public void setLabelFontWeight(double newLabelFontWeight) Description copied from interface:PresentationModel
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 variablesPresentationModel.FONT_WEIGHT_NORMAL
andPresentationModel.FONT_WEIGHT_BOLD
be used for the most compatibility across platforms. This is a bound property of typeDouble
.- Specified by:
setLabelFontWeight
in interfacePresentationModel
- Parameters:
newLabelFontWeight
- The weight of the label font relative to a normal value of 0.5.- See Also:
-
getLabelTextColor
- Specified by:
getLabelTextColor
in interfacePresentationModel
- Returns:
- The text color of the label, or
null
if no text color is specified for the label.
-
setLabelTextColor
Description copied from interface:PresentationModel
Sets the text color of the label. This is a bound property.- Specified by:
setLabelTextColor
in interfacePresentationModel
- Parameters:
newLabelTextColor
- The text color of the label, ornull
if the default text color should be used.- See Also:
-
getMarginExtent
Description copied from interface:PresentationModel
Returns the margin extent of the indicated border.- Specified by:
getMarginExtent
in interfacePresentationModel
- Parameters:
border
- The border for which a margin extent should be returned.- Returns:
- The margin extent of the given border.
-
getMarginLineNearExtent
Description copied from interface:PresentationModel
Returns the margin extent of the line near page near border.- Specified by:
getMarginLineNearExtent
in interfacePresentationModel
- Returns:
- The margin extent of the given border.
-
getMarginLineFarExtent
Description copied from interface:PresentationModel
Returns the margin extent of the line far page near border.- Specified by:
getMarginLineFarExtent
in interfacePresentationModel
- Returns:
- The margin extent of the given border.
-
getMarginPageNearExtent
Description copied from interface:PresentationModel
Returns the margin extent of the line near page far border.- Specified by:
getMarginPageNearExtent
in interfacePresentationModel
- Returns:
- The margin extent of the given border.
-
getMarginPageFarExtent
Description copied from interface:PresentationModel
Returns the margin extent of the line far page far border.- Specified by:
getMarginPageFarExtent
in interfacePresentationModel
- Returns:
- The margin extent of the given border.
-
setMarginExtent
Description copied from interface:PresentationModel
Sets the margin extent of a given border. The margin extent of each border represents a bound property.- Specified by:
setMarginExtent
in interfacePresentationModel
- Parameters:
border
- The border for which the margin extent should be set.newMarginExtent
- The margin extent.- See Also:
-
setMarginLineNearExtent
Description copied from interface:PresentationModel
Sets the margin extent of the line near border. This is a bound property.- Specified by:
setMarginLineNearExtent
in interfacePresentationModel
- Parameters:
newMarginExtent
- The margin extent.- See Also:
-
setMarginLineFarExtent
Description copied from interface:PresentationModel
Sets the margin extent of the line far border. This is a bound property.- Specified by:
setMarginLineFarExtent
in interfacePresentationModel
- Parameters:
newMarginExtent
- The margin extent, ornull
if the default margin extent should be used.- See Also:
-
setMarginPageNearExtent
Description copied from interface:PresentationModel
Sets the margin extent of the page near border. This is a bound property.- Specified by:
setMarginPageNearExtent
in interfacePresentationModel
- Parameters:
newMarginExtent
- The margin extent, ornull
if the default margin extent should be used.- See Also:
-
setMarginPageFarExtent
Description copied from interface:PresentationModel
Sets the margin extent of the page far border. This is a bound property.- Specified by:
setMarginPageFarExtent
in interfacePresentationModel
- Parameters:
newMarginExtent
- The margin extent, ornull
if the default margin extent should be used.- See Also:
-
setMarginExtent
Description copied from interface:PresentationModel
Sets the margin extent of all borders. The margin extent of each border represents a bound property. This is a convenience method that callsPresentationModel.setMarginExtent(Border, Extent)
for each border.- Specified by:
setMarginExtent
in interfacePresentationModel
- Parameters:
newMarginExtent
- The margin extent.- See Also:
-
getOpacity
public double getOpacity()- Specified by:
getOpacity
in interfacePresentationModel
- Returns:
- The opacity of the entire component in the range (0.0-1.0), with a default of 1.0.
-
setOpacity
public void setOpacity(double newOpacity) Description copied from interface:PresentationModel
Sets the opacity of the entire component. This is a bound property of typeDouble
.- Specified by:
setOpacity
in interfacePresentationModel
- Parameters:
newOpacity
- The new opacity of the entire component in the range (0.0-1.0).- See Also:
-
getPaddingExtent
Description copied from interface:PresentationModel
Returns the padding extent of the indicated border.- Specified by:
getPaddingExtent
in interfacePresentationModel
- Parameters:
border
- The border for which a padding extent should be returned.- Returns:
- The padding extent of the given border.
-
getPaddingLineNearExtent
Description copied from interface:PresentationModel
Returns the padding extent of the line near page near border.- Specified by:
getPaddingLineNearExtent
in interfacePresentationModel
- Returns:
- The padding extent of the given border.
-
getPaddingLineFarExtent
Description copied from interface:PresentationModel
Returns the padding extent of the line far page near border.- Specified by:
getPaddingLineFarExtent
in interfacePresentationModel
- Returns:
- The padding extent of the given border.
-
getPaddingPageNearExtent
Description copied from interface:PresentationModel
Returns the padding extent of the line near page far border.- Specified by:
getPaddingPageNearExtent
in interfacePresentationModel
- Returns:
- The padding extent of the given border.
-
getPaddingPageFarExtent
Description copied from interface:PresentationModel
Returns the padding extent of the line far page far border.- Specified by:
getPaddingPageFarExtent
in interfacePresentationModel
- Returns:
- The padding extent of the given border.
-
setPaddingExtent
Description copied from interface:PresentationModel
Sets the padding extent of a given border. The padding extent of each border represents a bound property.- Specified by:
setPaddingExtent
in interfacePresentationModel
- Parameters:
border
- The border for which the padding extent should be set.newPaddingExtent
- The padding extent.- See Also:
-
setPaddingLineNearExtent
Description copied from interface:PresentationModel
Sets the padding extent of the line near border. This is a bound property.- Specified by:
setPaddingLineNearExtent
in interfacePresentationModel
- Parameters:
newPaddingExtent
- The padding extent.- See Also:
-
setPaddingLineFarExtent
Description copied from interface:PresentationModel
Sets the padding extent of the line far border. This is a bound property.- Specified by:
setPaddingLineFarExtent
in interfacePresentationModel
- Parameters:
newPaddingExtent
- The padding extent, ornull
if the default padding extent should be used.- See Also:
-
setPaddingPageNearExtent
Description copied from interface:PresentationModel
Sets the padding extent of the page near border. This is a bound property.- Specified by:
setPaddingPageNearExtent
in interfacePresentationModel
- Parameters:
newPaddingExtent
- The padding extent, ornull
if the default padding extent should be used.- See Also:
-
setPaddingPageFarExtent
Description copied from interface:PresentationModel
Sets the padding extent of the page far border. This is a bound property.- Specified by:
setPaddingPageFarExtent
in interfacePresentationModel
- Parameters:
newPaddingExtent
- The padding extent, ornull
if the default padding extent should be used.- See Also:
-
setPaddingExtent
Description copied from interface:PresentationModel
Sets the padding extent of all borders. The padding extent of each border represents a bound property. This is a convenience method that callsPresentationModel.setPaddingExtent(Border, Extent)
for each border.- Specified by:
setPaddingExtent
in interfacePresentationModel
- Parameters:
newPaddingExtent
- The padding extent.- See Also:
-
getStyleID
- Specified by:
getStyleID
in interfacePresentationModel
- Returns:
- The style identifier, or
null
if there is no style ID.
-
setStyleID
Description copied from interface:PresentationModel
Identifies the style for the component. This is a bound property.- Specified by:
setStyleID
in interfacePresentationModel
- Parameters:
newStyleID
- The style identifier, ornull
if there is no style ID.- See Also:
-
isVisible
public boolean isVisible()- Specified by:
isVisible
in interfacePresentationModel
- Returns:
- Whether the component is visible.
- See Also:
-
setVisible
public void setVisible(boolean newVisible) Description copied from interface:PresentationModel
Sets whether the component is visible. This is a bound property of typeBoolean
.- Specified by:
setVisible
in interfacePresentationModel
- Parameters:
newVisible
-true
if the component should be visible, elsefalse
.- See Also:
-
isDisplayed
public boolean isDisplayed()- Specified by:
isDisplayed
in interfaceDisplayable
- Specified by:
isDisplayed
in interfacePresentationModel
- Returns:
- Whether the component is displayed or has no representation, taking up no space.
- See Also:
-
setDisplayed
public void setDisplayed(boolean newDisplayed) Description copied from interface:PresentationModel
Sets whether the component is displayed or has no representation, taking up no space. This is a bound property of typeBoolean
.- Specified by:
setDisplayed
in interfaceDisplayable
- Specified by:
setDisplayed
in interfacePresentationModel
- Parameters:
newDisplayed
-true
if the component should be displayed, elsefalse
if the component should take up no space.- See Also:
-
getTextColor
- Specified by:
getTextColor
in interfacePresentationModel
- Returns:
- The text color of the component, or
null
if no text color is specified.
-
setTextColor
Description copied from interface:PresentationModel
Sets the text color of the component. This is a bound property.- Specified by:
setTextColor
in interfacePresentationModel
- Parameters:
newTextColor
- The text color of the component, ornull
if the default text color should be used.- See Also:
-
isTooltipEnabled
public boolean isTooltipEnabled()- Specified by:
isTooltipEnabled
in interfacePresentationModel
- Returns:
- Whether tooltips are enabled for this component.
-
setTooltipEnabled
public void setTooltipEnabled(boolean newTooltipEnabled) Description copied from interface:PresentationModel
Sets whether tooltips are enabled for this component. Tooltips contain information from the component model's "info" property. This is a bound property of typeBoolean
.- Specified by:
setTooltipEnabled
in interfacePresentationModel
- Parameters:
newTooltipEnabled
-true
if the component should display tooltips, elsefalse
.- See Also:
-