Class ViewTitleBarProperties
- Since:
- IDW 1.4.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final IntegerProperty
Content title bar gap propertystatic final DirectionProperty
Direction propertystatic final PropertyMapProperty
Focused properties.static final HoverListenerProperty
Hover listener propertystatic final DimensionProviderProperty
Title bar minimum size propertystatic final PropertyMapProperty
Normal propertiesstatic final DirectionProperty
Orientation propertystatic final PropertyMapGroup
Property group containing all view title bar properties.static final BooleanProperty
Visible property -
Constructor Summary
ConstructorsConstructorDescriptionCreates an empty property object.ViewTitleBarProperties
(ViewTitleBarProperties inheritFrom) Creates a property object that inherit values from another property object.Creates a property object containing the map. -
Method Summary
Modifier and TypeMethodDescriptionaddSuperObject
(ViewTitleBarProperties properties) Adds a super object from which property values are inherited.int
Returns the gap between the view's content and the title barReturns the layout directionReturns the property values for the title bar's focused stateGets the hover listener that will be triggered when the title bar is hovered by the mouse.Gets the dimension provider for the title bar's minimum sizeReturns the property values for the title bar's normal stateReturns the orientation i.e.boolean
Returns if the title bar should be visible or notremoveSuperObject
(ViewTitleBarProperties superObject) Removes a super object.setContentTitleBarGap
(int gap) Sets the gap between the view's content and the title barsetDirection
(Direction direction) Sets the layout directionsetHoverListener
(HoverListener listener) Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.Sets the title bar's minimum size dimension providersetOrientation
(Direction orientation) Sets the orientation i.e.setVisible
(boolean visible) Sets if the title bar should be visible or notMethods inherited from class net.infonode.properties.propertymap.PropertyMapContainer
getMap
-
Field Details
-
PROPERTIES
Property group containing all view title bar properties. -
NORMAL_PROPERTIES
Normal properties- See Also:
-
FOCUSED_PROPERTIES
Focused properties. Added as super object to normal properties when view has focus- See Also:
-
VISIBLE
Visible property- See Also:
-
MINIMUM_SIZE_PROVIDER
Title bar minimum size property- See Also:
-
CONTENT_TITLE_BAR_GAP
Content title bar gap property- See Also:
-
ORIENTATION
Orientation property- See Also:
-
DIRECTION
Direction property- See Also:
-
HOVER_LISTENER
Hover listener property- See Also:
-
-
Constructor Details
-
ViewTitleBarProperties
public ViewTitleBarProperties()Creates an empty property object. -
ViewTitleBarProperties
Creates a property object containing the map.- Parameters:
map
- the property map
-
ViewTitleBarProperties
Creates a property object that inherit values from another property object.- Parameters:
inheritFrom
- the object from which to inherit property values
-
-
Method Details
-
addSuperObject
Adds a super object from which property values are inherited.- Parameters:
properties
- the object from which to inherit property values- Returns:
- this
-
removeSuperObject
Removes a super object.- Parameters:
superObject
- the super object to remove- Returns:
- this
-
getNormalProperties
Returns the property values for the title bar's normal state- Returns:
- the property values for the title bar's normal state
-
getFocusedProperties
Returns the property values for the title bar's focused state
Note:These properties are added as super object to the normal properties when the view has focus.
- Returns:
- the property values for the title bar's focused state
-
setVisible
Sets if the title bar should be visible or not- Parameters:
visible
- True for visible, otherwise false- Returns:
- this
-
getVisible
public boolean getVisible()Returns if the title bar should be visible or not- Returns:
- True if visible, otherwise false
-
setMinimumSizeProvider
Sets the title bar's minimum size dimension provider- Parameters:
size
- the minimum size dimension provider or null if title bar's default minimum size should be used instead- Returns:
- this ViewTitleBarProperties
-
getMinimumSizeProvider
Gets the dimension provider for the title bar's minimum size- Returns:
- the minimum size provider or null if default title bar minimum size is to be used instead
-
setContentTitleBarGap
Sets the gap between the view's content and the title bar- Parameters:
gap
- gap in pixels- Returns:
- this
-
getContentTitleBarGap
public int getContentTitleBarGap()Returns the gap between the view's content and the title bar- Returns:
- gap in pixels
-
setOrientation
Sets the orientation i.e. on what side of the view's content the title bar will be placed- Parameters:
orientation
- the orientation- Returns:
- this
-
getOrientation
Returns the orientation i.e. on what side of the view's content the title bar will be placed- Returns:
- the orientation
-
setDirection
Sets the layout direction
The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.
- Parameters:
direction
- the layout direction- Returns:
- this
-
getDirection
Returns the layout direction
The icon, text and components are laid out in a line that will be rotated in the given direction. The text and icon is rotated and the components are only moved.
- Returns:
- the layout direction
-
setHoverListener
Sets the hover listener that will be triggered when the title bar is hoverd by the mouse.
The view that contains the title bar will be the source of the hover event sent to the hover listener.
- Parameters:
listener
- the hover listener- Returns:
- this
- See Also:
-
getHoverListener
Gets the hover listener that will be triggered when the title bar is hovered by the mouse.
The view that contains the title bar will be the source of the hover event sent to the hover listener.
- Returns:
- the hover listener
- See Also:
-